diff mbox series

[bug#54561] v2 [PATCH 2/5] doc: Add "Samba" chapter.

Message ID 20220408182131.10271-3-simon@netpanic.org
State Accepted
Headers show
Series [bug#54561] v2 [PATCH 2/5] doc: Add "Samba" chapter. | expand

Commit Message

Simon Streit April 8, 2022, 6:21 p.m. UTC 
---
 doc/guix.texi | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

Comments

Ludovic Courtès April 8, 2022, 9:35 p.m. UTC | #1 
Simon Streit <simon@netpanic.org> skribis:

> +@cindex samba
> +@cindex smb

“Samba” and “SMB”.

> +The @code{(gnu services samba)} module provides Guix service definitions

s/Guix//

> +for Samba as well as additional helper services.  Currently it provides
> +the following services:
> +
> +@subsubheading Samba

Remove colon after “services” (what follows is not a bullet list).

> +Samba provides network shares for folder and printers,

How about:

  @uref{https://www.samba.org, Samba} provides networks shares for
  folders and printers using the SMB/CIFS protocol commonly used on
  Windows.

>  it can also be an
> +AD DC for other samba hosts in an heterougenious network with different

What’s an “AD DC”?  In general please expand acronyms on their first
occurrence.

> +types of Computer systems.

Lowercase.

> +@defvar{samba-service-type}

Please use @defvr as is done elsewhere in the manual.

> +The service type to enable the samba services @code{samba}, @code{nmbd},
> +@code{smbd} and @code{winbindd}.  By default this service type does not
> +run as an AD DC, hence @code{samba} remains disabled.  It is recommended
> +that Samba's package is added to the system profile to have the tool-set

Samba is now added to the system profile, right?  Should this sentence
be removed?

Ludo’.
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index e8ef4286be..70f78c601a 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -101,6 +101,7 @@  Copyright @copyright{} 2021 Andrew Tropin@*
 Copyright @copyright{} 2021 Sarah Morgensen@*
 Copyright @copyright{} 2021 Josselin Poiret@*
 Copyright @copyright{} 2022 Remco van 't Veer@*
+Copyright @copyright{} 2022 Simon Streit@*
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -368,6 +369,7 @@  Services
 * DNS Services::                DNS daemons.
 * VPN Services::                VPN daemons.
 * Network File System::         NFS related services.
+* Samba Services::              Samba services.
 * Continuous Integration::      Cuirass and Laminar services.
 * Power Management Services::   Extending battery life.
 * Audio Services::              The MPD.
@@ -29861,6 +29863,56 @@  The verbosity level of the daemon.
 @end table
 @end deftp
 
+@node Samba Services, Continuous Integration, Network File System, Services
+@subsection Samba Services
+
+@cindex samba
+@cindex smb
+The @code{(gnu services samba)} module provides Guix service definitions
+for Samba as well as additional helper services.  Currently it provides
+the following services:
+
+@subsubheading Samba
+
+Samba provides network shares for folder and printers, it can also be an
+AD DC for other samba hosts in an heterougenious network with different
+types of Computer systems.
+
+@defvar{samba-service-type}
+
+The service type to enable the samba services @code{samba}, @code{nmbd},
+@code{smbd} and @code{winbindd}.  By default this service type does not
+run as an AD DC, hence @code{samba} remains disabled.  It is recommended
+that Samba's package is added to the system profile to have the tool-set
+available for modifications in Samba's runtime directories.
+
+@end defvar
+
+@deftp{Data Type} samba-service-configuration
+Configuration record for the Samba suite.
+
+@table @asis
+@item @code{package} (default: @code{samba})
+The samba package to use.
+
+@item @code{config-file} (default: @code{#f})
+The config file to use.
+
+@item @code{enable-samba?} (default: @code{#f})
+Manually enable the @code{samba} daemon.
+
+@item @code{enable-smbd?} (default: @code{#f})
+Manually enable the @code{smbd} daemon.
+
+@item @code{enable-nmbd?} (default: @code{#f})
+Manually enable the @code{nmbd} daemon.
+
+@item @code{enable-winbindd?} (default: @code{#f})
+Manually enable the @code{winbindd} daemon.
+
+@end table
+@end deftp
+
 @node Continuous Integration
 @subsection Continuous Integration