branch master updated: doc: Typographic improvements.

[guix-commits]

This is an automated email from the git hooks/post-receive script.

ngz pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new 826c2ee  doc: Typographic improvements.
826c2ee is described below

commit 826c2eecbe59daf338e4c19b1e42c725fefeef2e
Author: Nicolas Goaziou <address@hidden>
AuthorDate: Tue May 5 16:38:29 2020 +0200

    doc: Typographic improvements.
    
    * doc/guix.texi (Networking Services): Use @var, @option, and @command when
    appropriate.  Add two spaces after sentences.
---
 doc/guix.texi | 60 ++++++++++++++++++++++++++++++++---------------------------
 1 file changed, 33 insertions(+), 27 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 812d08a..6b5b8bf 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -14394,18 +14394,21 @@ Whether to enable password-based authentication.
 @cindex AutoSSH
 @deffn {Scheme Variable} autossh-service-type
 This is the type for the @uref{https://www.harding.motd.ca/autossh,
-AutoSSH} program that runs a copy of @code{ssh} and monitors it,
+AutoSSH} program that runs a copy of @command{ssh} and monitors it,
 restarting it as necessary should it die or stop passing traffic.
-AutoSSH can be run manually from the commandline by passing arguments to
-the binary @code{autossh} from the package @code{autossh}, but it can
-also be run as a guix service. This latter usecase is documented here.
+AutoSSH can be run manually from the command-line by passing arguments
+to the binary @command{autossh} from the package @code{autossh}, but it
+can also be run as a Guix service.  This latter use case is documented
+here.
 
-AutoSSH can be used to forward local traffic to a remote machine using an SSH 
tunnel,
-and it respects the @file{~/.ssh/config} of the user it is run as.
+AutoSSH can be used to forward local traffic to a remote machine using
+an SSH tunnel, and it respects the @file{~/.ssh/config} of the user it
+is run as.
 
-For example, to specify a service running autossh as the user @code{pino}
-and forwarding all local connections to port @code{8081} to @code{remote:8081}
-using an SSH tunnel, add this call to the operating system's @code{services} 
field:
+For example, to specify a service running autossh as the user
+@code{pino} and forwarding all local connections to port @code{8081} to
+@code{remote:8081} using an SSH tunnel, add this call to the operating
+system's @code{services} field:
 
 @lisp
 (service autossh-service-type
@@ -14428,18 +14431,19 @@ This assumes that the specified user exists.
 Specifies the connection poll time in seconds.
 
 @item @code{first-poll} (default @code{#f})
-Specifies how long autossh waits before the first connection test in seconds.
-After this first test, polling is resumed at the pace defined in @code{poll}.
-When set to @code{#f}, the first poll is not treated specially and
-will also use the connection poll specified in @code{poll}
+Specifies how many seconds AutoSSH waits before the first connection
+test.  After this first test, polling is resumed at the pace defined in
+@code{poll}.  When set to @code{#f}, the first poll is not treated
+specially and will also use the connection poll specified in
+@code{poll}.
 
 @item @code{gate-time} (default @code{30})
-Specifies (in seconds) how long an SSH connection must be active
-before it is considered successful.
+Specifies how many seconds an SSH connection must be active before it is
+considered successful.
 
 @item @code{log-level} (default @code{1})
-The log level, corresponding to the levels used by syslog
-(so @code{0} is the most silent while @code{7} is the chattiest.)
+The log level, corresponding to the levels used by syslog---so @code{0}
+is the most silent while @code{7} is the chattiest.
 
 @item @code{max-start} (default @code{#f})
 The maximum number of times SSH may be (re)started before AutoSSH exits.
@@ -14449,18 +14453,20 @@ When set to @code{#f}, no maximum is configured and 
AutoSSH may restart indefini
 The message to append to the echo message sent when testing connections.
 
 @item @code{port} (default @code{"0"})
-The ports used for monitoring the connection. When set to @code{"0"},
-monitoring is disabled. When set to @code{"n"} where @code{n} is a positive 
integer,
-ports @code{n} and @code{n+1} are used for monitoring the connection, such that
-port @code{n} is the base monitoring port and @code{n+1} is the echo port.
-When set to @code{"n:m"} where @code{n} and @code{m} are positive integers,
-the ports @code{n} and @code{n+1} are used for monitoring the connection, such
-that port @code{n} is the base monitoring port and @code{m} is the echo port.
+The ports used for monitoring the connection.  When set to @code{"0"},
+monitoring is disabled.  When set to @code{"@var{n}"} where @var{n} is
+a positive integer, ports @var{n} and @var{n}+1 are used for
+monitoring the connection, such that port @var{n} is the base
+monitoring port and @code{n+1} is the echo port.  When set to
+@code{"@var{n}:@var{m}"} where @var{n} and @var{m} are positive
+integers, the ports @var{n} and @var{n}+1 are used for monitoring the
+connection, such that port @var{n} is the base monitoring port and
+@var{m} is the echo port.
 
 @item @code{ssh-options} (default @code{'()})
-The list of commandline arguments to pass to ssh when it is run.
-Options @code{-f} and @code{-M ....} are reserved for AutoSSH
-and may cause undefined behaviour.
+The list of command-line arguments to pass to @command{ssh} when it is
+run.  Options @option{-f} and @option{-M} are reserved for AutoSSH and
+may cause undefined behaviour.
 
 @end table
 @end deftp