[bug#68453] closed (Re: bug#68453: [PATCH] doc: Improve VNC Services section.)

Message ID CAEtmmewgzfNH4tk=2abLEENC47TCa3Y=5aHQ-sFy6PJhL+2mnA@mail.gmail.com
State New
Headers
Series [bug#68453] closed (Re: bug#68453: [PATCH] doc: Improve VNC Services section.) |

Commit Message

Rostislav Svoboda April 9, 2025, 3:26 p.m. UTC
  Hello,

> I like how it is now more in my opinion.
> Your suggestion is harder to understand in my opinion.

All right. Then let's just:

- use the same display number for consistency
- mention that the we're doing SSH tunneling
- use different port numbers in the examples, so that it is easier to
understand where/what is "local" and where/what is "remote"

The patch is attached.

Cheers,
Bost
  

Patch

From 9bf0d51aa1351d12bf5115b7adc3aee8ec7fde75 Mon Sep 17 00:00:00 2001
Message-ID: <9bf0d51aa1351d12bf5115b7adc3aee8ec7fde75.1744212208.git.Rostislav.Svoboda@gmail.com>
From: Rostislav Svoboda <Rostislav.Svoboda@gmail.com>
Date: Thu, 13 Mar 2025 15:12:44 +0100
Subject: [PATCH] doc: Improve VNC Services section.

* doc/guix.texi (VNC Services): Don't change the value of
`display-number`. Refine the `xclock` and `vncviewer` invocation examples.

Change-Id: I3175072d41ac8efb0a33e1d4fb29afaff7fc06dd
---
 doc/guix.texi | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index bee80cd4e2..a0efb46ed5 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -35898,18 +35898,19 @@  VNC Services
 
 @lisp
 (service xvnc-service-type
-         (xvnc-configuration (display-number 10)))
+         (xvnc-configuration (display-number 5)))
 @end lisp
 
 As a demonstration, the @command{xclock} command could then be started
 on the remote machine on display number 10, and it could be displayed
-locally via the @command{vncviewer} command:
+locally using the SSH tunneling mechanism, via the @command{vncviewer}
+command:
 @example
 # Start xclock on the remote machine.
-ssh -L5910:localhost:5910 @var{your-host} -- guix shell xclock \
-    -- env DISPLAY=:10 xclock
-# Access it via VNC.
-guix shell tigervnc-client -- vncviewer localhost:5910
+ssh -L5906:localhost:5905 @var{your-host} -- guix shell xclock \
+    -- env DISPLAY=:5 xclock
+# Access the xclock via VNC.
+guix shell tigervnc-client -- vncviewer localhost:5906
 @end example
 
 The following configuration combines XDMCP and Inetd to allow multiple

base-commit: f0c0769189d11debf7b237a02695c44c9773d52a
-- 
2.49.0