me/guix
Archived
1
0
Fork 0
Code Activity

doc: Typographic improvements.

Browse source 
* doc/guix.texi (Networking Services): Use @var, @option, and @command when
appropriate.  Add two spaces after sentences.
This commit is contained in:
Nicolas Goaziou 2020-05-05 16:38:29 +02:00
parent 77f5296236
commit 826c2eecbe
No known key found for this signature in database
GPG key ID: DA00B4F048E92F2D
1 changed files with 33 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
doc/guix.texi
View file

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