doc: Add xrefs to the lsh manual.

Suggested by Adam Pribyl <pribyl@lowlevel.cz>.

* gnu/services/ssh.scm (lsh-service): Update docstring with xrefs to
  the lsh manual.  Fix typos.
* doc/guix.texi (Networking Services): Synchronize.
This commit is contained in:
Ludovic Courtès 2014-11-24 21:15:40 +01:00
parent 1619111731
commit 20dd519cdb
2 changed files with 14 additions and 4 deletions

View file

@ -4033,12 +4033,17 @@ When @var{initialize?} is true, automatically create the seed and host key
upon service activation if they do not exist yet. This may take long and upon service activation if they do not exist yet. This may take long and
require interaction. require interaction.
When @var{initialize?} is false, it is up to the user to initialize the
randomness generator (@pxref{lsh-make-seed,,, lsh, LSH Manual}), and to create
a key pair with the private key stored in file @var{host-key} (@pxref{lshd
basics,,, lsh, LSH Manual}).
When @var{interfaces} is empty, lshd listens for connections on all the When @var{interfaces} is empty, lshd listens for connections on all the
network interfaces; otherwise, @var{interfaces} must be a list of host names network interfaces; otherwise, @var{interfaces} must be a list of host names
or addresses. or addresses.
@var{allow-empty-passwords?} specifies whether to accepts log-ins with empty @var{allow-empty-passwords?} specifies whether to accept log-ins with empty
passwords, and @var{root-login?} specifies whether to accepts log-ins as passwords, and @var{root-login?} specifies whether to accept log-ins as
root. root.
The other options should be self-descriptive. The other options should be self-descriptive.

View file

@ -91,12 +91,17 @@ (define* (lsh-service #:key
upon service activation if they do not exist yet. This may take long and upon service activation if they do not exist yet. This may take long and
require interaction. require interaction.
When @var{initialize?} is false, it is up to the user to initialize the
randomness generator (@pxref{lsh-make-seed,,, lsh, LSH Manual}), and to create
a key pair with the private key stored in file @var{host-key} (@pxref{lshd
basics,,, lsh, LSH Manual}).
When @var{interfaces} is empty, lshd listens for connections on all the When @var{interfaces} is empty, lshd listens for connections on all the
network interfaces; otherwise, @var{interfaces} must be a list of host names network interfaces; otherwise, @var{interfaces} must be a list of host names
or addresses. or addresses.
@var{allow-empty-passwords?} specifies whether to accepts log-ins with empty @var{allow-empty-passwords?} specifies whether to accept log-ins with empty
passwords, and @var{root-login?} specifies whether to accepts log-ins as passwords, and @var{root-login?} specifies whether to accept log-ins as
root. root.
The other options should be self-descriptive." The other options should be self-descriptive."