summary refs log tree commit diff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2022-06-19 16:05:19 +0200
committerLudovic Courtès <ludo@gnu.org>2022-06-19 23:14:56 +0200
commit6337f62dde24ceaf50c25a0133346bba68c2d849 (patch)
tree3af1897c7477e07fd32dc68af827c19306cda501
parenta0500442557e2e7f0a138b6079df51290e3016dd (diff)
downloadguix-6337f62dde24ceaf50c25a0133346bba68c2d849.tar.gz
doc: Show (service ...) form in 'home-openssh-service-type' example.
* doc/guix.texi (Secure Shell): Include the (service ...) form in the
example.
-rw-r--r--doc/guix.texi26
1 files changed, 14 insertions, 12 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 86348fc02c..43a5fc85bd 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -39718,18 +39718,20 @@ optionally providing a @file{~/.ssh/known_hosts} file so that @file{ssh}
 can authenticate hosts you connect to.
 @end itemize
 
-Here is a sample configuration you could add to the @code{services}
-field of your @code{home-environment}:
-
-@lisp
-(home-openssh-configuration
- (hosts (list (openssh-host (name "ci.guix.gnu.org")
-                            (user "charlie"))
-              (openssh-host (name "chbouib")
-                            (host-name "chbouib.example.org")
-                            (user "supercharlie")
-                            (port 10022))))
- (authorized-keys (list (local-file "alice.pub"))))
+Here is an example of a service and its configuration that you could add
+to the @code{services} field of your @code{home-environment}:
+
+@lisp
+(service home-openssh-service-type
+         (home-openssh-configuration
+          (hosts
+           (list (openssh-host (name "ci.guix.gnu.org")
+                               (user "charlie"))
+                 (openssh-host (name "chbouib")
+                               (host-name "chbouib.example.org")
+                               (user "supercharlie")
+                               (port 10022))))
+          (authorized-keys (list (local-file "alice.pub")))))
 @end lisp
 
 The example above lists two hosts and their parameters.  For instance,