Archived
1
0
Fork 0

doc: guix: Fix some markup.

* doc/guix.texi (Build Systems):
(Base Services):
(X Window):
(Printing Services):
(Mail Services):
(Messaging Services):
(LDAP Services):
(Virtualization Services):
(Version Control Services): Use @samp, @code and double quotes where
appropriate.
This commit is contained in:
Nicolas Goaziou 2020-04-25 23:35:44 +02:00
parent 128b136ec6
commit d558de8048
No known key found for this signature in database
GPG key ID: DA00B4F048E92F2D

View file

@ -6099,8 +6099,8 @@ implements a build procedure for Android NDK (native development kit)
packages using a Guix-specific build process. packages using a Guix-specific build process.
The build system assumes that packages install their public interface The build system assumes that packages install their public interface
(header) files to the subdirectory "include" of the "out" output and (header) files to the subdirectory @file{include} of the @code{out} output and
their libraries to the subdirectory "lib" of the "out" output. their libraries to the subdirectory @file{lib} the @code{out} output.
It's also assumed that the union of all the dependencies of a package It's also assumed that the union of all the dependencies of a package
has no conflicting files. has no conflicting files.
@ -6802,8 +6802,8 @@ kernel module.
@end table @end table
It is possible and useful to specify the Linux kernel to use for building It is possible and useful to specify the Linux kernel to use for building
the module (in the "arguments" form of a package using the the module (in the @code{arguments} form of a package using the
linux-module-build-system, use the key #:linux to specify it). @code{linux-module-build-system}, use the key @code{#:linux} to specify it).
@end defvr @end defvr
@defvr {Scheme Variable} node-build-system @defvr {Scheme Variable} node-build-system
@ -12427,7 +12427,7 @@ man page for more information.
@item @code{tty} @item @code{tty}
The name of the console this agetty runs on, as a string---e.g., The name of the console this agetty runs on, as a string---e.g.,
@code{"ttyS0"}. This argument is optional, it will default to @code{"ttyS0"}. This argument is optional, it will default to
a reasonable default serial port used by the kernel Linux. a reasonable default serial port used by the kernel Linux.
For this, if there is a value for an option @code{agetty.tty} in the kernel For this, if there is a value for an option @code{agetty.tty} in the kernel
@ -12462,7 +12462,7 @@ in automatically without prompting for their login name or password.
When @code{#t}, don't reset terminal cflags (control modes). When @code{#t}, don't reset terminal cflags (control modes).
@item @code{host} (default: @code{#f}) @item @code{host} (default: @code{#f})
This accepts a string containing the "login_host", which will be written This accepts a string containing the ``login_host'', which will be written
into the @file{/var/run/utmpx} file. into the @file{/var/run/utmpx} file.
@item @code{remote?} (default: @code{#f}) @item @code{remote?} (default: @code{#f})
@ -12568,8 +12568,8 @@ This option accepts a string of additional characters that should be
interpreted as backspace when the user types their login name. interpreted as backspace when the user types their login name.
@item @code{kill-characters} (default: @code{#f}) @item @code{kill-characters} (default: @code{#f})
This option accepts a string that should be interpreted to mean "ignore This option accepts a string that should be interpreted to mean ``ignore
all previous characters" (also called a "kill" character) when the user all previous characters'' (also called a ``kill'' character) when the user
types their login name. types their login name.
@item @code{chdir} (default: @code{#f}) @item @code{chdir} (default: @code{#f})
@ -12585,7 +12585,7 @@ This option accepts, as an integer, the nice value with which to run the
@command{login} program. @command{login} program.
@item @code{extra-options} (default: @code{'()}) @item @code{extra-options} (default: @code{'()})
This option provides an "escape hatch" for the user to provide arbitrary This option provides an ``escape hatch'' for the user to provide arbitrary
command-line arguments to @command{agetty} as a list of strings. command-line arguments to @command{agetty} as a list of strings.
@end table @end table
@ -14691,15 +14691,15 @@ The default SLiM theme and its name.
@deftp {Data Type} sddm-configuration @deftp {Data Type} sddm-configuration
This is the data type representing the sddm service configuration. This is the data type representing the SDDM service configuration.
@table @asis @table @asis
@item @code{display-server} (default: "x11") @item @code{display-server} (default: "x11")
Select display server to use for the greeter. Valid values are "x11" Select display server to use for the greeter. Valid values are
or "wayland". @samp{"x11"} or @samp{"wayland"}.
@item @code{numlock} (default: "on") @item @code{numlock} (default: "on")
Valid values are "on", "off" or "none". Valid values are @samp{"on"}, @samp{"off"} or @samp{"none"}.
@item @code{halt-command} (default @code{#~(string-apppend #$shepherd "/sbin/halt")}) @item @code{halt-command} (default @code{#~(string-apppend #$shepherd "/sbin/halt")})
Command to run when halting. Command to run when halting.
@ -14708,7 +14708,8 @@ Command to run when halting.
Command to run when rebooting. Command to run when rebooting.
@item @code{theme} (default "maldives") @item @code{theme} (default "maldives")
Theme to use. Default themes provided by SDDM are "elarun", "maldives" or "maya". Theme to use. Default themes provided by SDDM are @samp{"elarun"},
@samp{"maldives"} or @samp{"maya"}.
@item @code{themes-directory} (default "/run/current-system/profile/share/sddm/themes") @item @code{themes-directory} (default "/run/current-system/profile/share/sddm/themes")
Directory to look for themes. Directory to look for themes.
@ -15196,9 +15197,9 @@ Defaults to @samp{#f}.
@deftypevr {@code{cups-configuration} parameter} string classification @deftypevr {@code{cups-configuration} parameter} string classification
Specifies the security classification of the server. Any valid banner Specifies the security classification of the server. Any valid banner
name can be used, including "classified", "confidential", "secret", name can be used, including @samp{"classified"}, @samp{"confidential"},
"topsecret", and "unclassified", or the banner can be omitted to disable @samp{"secret"}, @samp{"topsecret"}, and @samp{"unclassified"}, or the
secure printing functions. banner can be omitted to disable secure printing functions.
Defaults to @samp{""}. Defaults to @samp{""}.
@end deftypevr @end deftypevr
@ -15400,7 +15401,7 @@ Defaults to @samp{()}.
@deftypevr {@code{method-access-controls} parameter} access-control-list access-controls @deftypevr {@code{method-access-controls} parameter} access-control-list access-controls
Access control directives, as a list of strings. Each string should be Access control directives, as a list of strings. Each string should be
one directive, such as "Order allow,deny". one directive, such as @samp{"Order allow,deny"}.
Defaults to @samp{()}. Defaults to @samp{()}.
@end deftypevr @end deftypevr
@ -15481,7 +15482,7 @@ Defaults to @samp{0}.
@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-job-time @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-job-time
Specifies the maximum time a job may take to print before it is Specifies the maximum time a job may take to print before it is
canceled, in seconds. Set to 0 to disable cancellation of "stuck" jobs. canceled, in seconds. Set to 0 to disable cancellation of ``stuck'' jobs.
Defaults to @samp{10800}. Defaults to @samp{10800}.
@end deftypevr @end deftypevr
@ -17216,12 +17217,12 @@ if the user doesn't yet have any mail, so you should explicitly tell
Dovecot the full location. Dovecot the full location.
If you're using mbox, giving a path to the INBOX If you're using mbox, giving a path to the INBOX
file (e.g.@: /var/mail/%u) isn't enough. You'll also need to tell Dovecot file (e.g.@: @file{/var/mail/%u}) isn't enough. You'll also need to tell Dovecot
where the other mailboxes are kept. This is called the "root mail where the other mailboxes are kept. This is called the @emph{root mail
directory", and it must be the first path given in the directory}, and it must be the first path given in the
@samp{mail-location} setting. @samp{mail-location} setting.
There are a few special variables you can use, eg.: There are a few special variables you can use, e.g.:
@table @samp @table @samp
@item %u @item %u
@ -17258,31 +17259,31 @@ Defaults to @samp{""}.
@deftypevr {@code{dovecot-configuration} parameter} string mail-privileged-group @deftypevr {@code{dovecot-configuration} parameter} string mail-privileged-group
Group to enable temporarily for privileged operations. Currently Group to enable temporarily for privileged operations. Currently
this is used only with INBOX when either its initial creation or this is used only with INBOX when either its initial creation or
dotlocking fails. Typically this is set to "mail" to give access to dotlocking fails. Typically this is set to @samp{"mail"} to give access to
/var/mail. @file{/var/mail}.
Defaults to @samp{""}. Defaults to @samp{""}.
@end deftypevr @end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} string mail-access-groups @deftypevr {@code{dovecot-configuration} parameter} string mail-access-groups
Grant access to these supplementary groups for mail processes. Grant access to these supplementary groups for mail processes.
Typically these are used to set up access to shared mailboxes. Note Typically these are used to set up access to shared mailboxes. Note
that it may be dangerous to set these if users can create that it may be dangerous to set these if users can create symlinks
symlinks (e.g.@: if "mail" group is set here, ln -s /var/mail ~/mail/var (e.g.@: if @samp{mail} group is set here, @code{ln -s /var/mail ~/mail/var}
could allow a user to delete others' mailboxes, or ln -s could allow a user to delete others' mailboxes, or @code{ln -s
/secret/shared/box ~/mail/mybox would allow reading it). /secret/shared/box ~/mail/mybox} would allow reading it). Defaults to
Defaults to @samp{""}. @samp{""}.
@end deftypevr @end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access? @deftypevr {@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access?
Allow full file system access to clients. There's no access checks Allow full file system access to clients. There's no access checks
other than what the operating system does for the active UID/GID. It other than what the operating system does for the active UID/GID. It
works with both maildir and mboxes, allowing you to prefix mailboxes works with both maildir and mboxes, allowing you to prefix mailboxes
names with e.g.@: /path/ or ~user/. names with e.g.@: @file{/path/} or @file{~user/}.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} boolean mmap-disable? @deftypevr {@code{dovecot-configuration} parameter} boolean mmap-disable?
Don't use mmap() at all. This is required if you store indexes to Don't use @code{mmap()} at all. This is required if you store indexes to
shared file systems (NFS or clustered file system). shared file systems (NFS or clustered file system).
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@ -17300,7 +17301,7 @@ When to use fsync() or fdatasync() calls:
@item optimized @item optimized
Whenever necessary to avoid losing important data Whenever necessary to avoid losing important data
@item always @item always
Useful with e.g.@: NFS when write()s are delayed Useful with e.g.@: NFS when @code{write()}s are delayed
@item never @item never
Never use it (best performance, but crashes can lose data). Never use it (best performance, but crashes can lose data).
@end table @end table
@ -17367,10 +17368,10 @@ Defaults to @samp{50}.
@deftypevr {@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs @deftypevr {@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs
List of directories under which chrooting is allowed for mail List of directories under which chrooting is allowed for mail
processes (i.e.@: /var/mail will allow chrooting to /var/mail/foo/bar processes (i.e.@: @file{/var/mail} will allow chrooting to @file{/var/mail/foo/bar}
too). This setting doesn't affect @samp{login-chroot} too). This setting doesn't affect @samp{login-chroot}
@samp{mail-chroot} or auth chroot settings. If this setting is empty, @samp{mail-chroot} or auth chroot settings. If this setting is empty,
"/./" in home dirs are ignored. WARNING: Never add directories here @samp{/./} in home dirs are ignored. WARNING: Never add directories here
which local users can modify, that may lead to root exploit. Usually which local users can modify, that may lead to root exploit. Usually
this should be done only if you don't allow shell access for users. this should be done only if you don't allow shell access for users.
<doc/wiki/Chrooting.txt>. <doc/wiki/Chrooting.txt>.
@ -17379,11 +17380,11 @@ Defaults to @samp{()}.
@deftypevr {@code{dovecot-configuration} parameter} string mail-chroot @deftypevr {@code{dovecot-configuration} parameter} string mail-chroot
Default chroot directory for mail processes. This can be overridden Default chroot directory for mail processes. This can be overridden
for specific users in user database by giving /./ in user's home for specific users in user database by giving @samp{/./} in user's home
directory (e.g.@: /home/./user chroots into /home). Note that usually directory (e.g.@: @samp{/home/./user} chroots into @file{/home}). Note that usually
there is no real need to do chrooting, Dovecot doesn't allow users to there is no real need to do chrooting, Dovecot doesn't allow users to
access files outside their mail directory anyway. If your home access files outside their mail directory anyway. If your home
directories are prefixed with the chroot directory, append "/."@: to directories are prefixed with the chroot directory, append @samp{/.} to
@samp{mail-chroot}. <doc/wiki/Chrooting.txt>. @samp{mail-chroot}. <doc/wiki/Chrooting.txt>.
Defaults to @samp{""}. Defaults to @samp{""}.
@end deftypevr @end deftypevr
@ -18490,7 +18491,7 @@ Curve for Elliptic curve Diffie-Hellman. Prosody's default is
@end deftypevr @end deftypevr
@deftypevr {@code{ssl-configuration} parameter} maybe-string-list verifyext @deftypevr {@code{ssl-configuration} parameter} maybe-string-list verifyext
A list of "extra" verification options. A list of ``extra'' verification options.
@end deftypevr @end deftypevr
@deftypevr {@code{ssl-configuration} parameter} maybe-string password @deftypevr {@code{ssl-configuration} parameter} maybe-string password
@ -18578,7 +18579,7 @@ example if you want your users to have addresses like
@samp{"john.smith@@example.com"} then you need to add a host @samp{"john.smith@@example.com"} then you need to add a host
@samp{"example.com"}. All options in this list will apply only to this host. @samp{"example.com"}. All options in this list will apply only to this host.
Note: the name "virtual" host is used in configuration to avoid confusion with Note: the name @emph{virtual} host is used in configuration to avoid confusion with
the actual physical host that Prosody is installed on. A single Prosody the actual physical host that Prosody is installed on. A single Prosody
instance can serve many domains, each one defined as a VirtualHost entry in instance can serve many domains, each one defined as a VirtualHost entry in
Prosody's configuration. Conversely a server that hosts a single domain would Prosody's configuration. Conversely a server that hosts a single domain would
@ -18624,7 +18625,7 @@ Multi-user chat (MUC) is Prosody's module for allowing you to create
hosted chatrooms/conferences for XMPP users. hosted chatrooms/conferences for XMPP users.
General information on setting up and using multi-user chatrooms can be found General information on setting up and using multi-user chatrooms can be found
in the "Chatrooms" documentation (@url{https://prosody.im/doc/chatrooms}), in the ``Chatrooms'' documentation (@url{https://prosody.im/doc/chatrooms}),
which you should read if you are new to XMPP chatrooms. which you should read if you are new to XMPP chatrooms.
See also @url{https://prosody.im/doc/modules/mod_muc}. See also @url{https://prosody.im/doc/modules/mod_muc}.
@ -19699,11 +19700,12 @@ Defaults to @samp{"nslcd"}.
@deftypevr {@code{nslcd-configuration} parameter} log-option log @deftypevr {@code{nslcd-configuration} parameter} log-option log
This option controls the way logging is done via a list containing This option controls the way logging is done via a list containing
SCHEME and LEVEL. The SCHEME argument may either be the symbols "none" SCHEME and LEVEL. The SCHEME argument may either be the symbols
or "syslog", or an absolute file name. The LEVEL argument is optional @samp{none} or @samp{syslog}, or an absolute file name. The LEVEL
and specifies the log level. The log level may be one of the following argument is optional and specifies the log level. The log level may be
symbols: "crit", "error", "warning", "notice", "info" or "debug". All one of the following symbols: @samp{crit}, @samp{error}, @samp{warning},
messages with the specified log level or higher are logged. @samp{notice}, @samp{info} or @samp{debug}. All messages with the
specified log level or higher are logged.
Defaults to @samp{("/var/log/nslcd" info)}. Defaults to @samp{("/var/log/nslcd" info)}.
@ -23585,7 +23587,7 @@ Defaults to @samp{()}.
@deftypevr {@code{libvirt-configuration} parameter} string tls-priority @deftypevr {@code{libvirt-configuration} parameter} string tls-priority
Override the compile time default TLS priority string. The default is Override the compile time default TLS priority string. The default is
usually "NORMAL" unless overridden at build time. Only set this is it usually @samp{"NORMAL"} unless overridden at build time. Only set this is it
is desired for libvirt to deviate from the global default settings. is desired for libvirt to deviate from the global default settings.
Defaults to @samp{"NORMAL"}. Defaults to @samp{"NORMAL"}.
@ -23719,11 +23721,12 @@ x:+name
where @code{name} is a string which is matched against the category where @code{name} is a string which is matched against the category
given in the @code{VIR_LOG_INIT()} at the top of each libvirt source given in the @code{VIR_LOG_INIT()} at the top of each libvirt source
file, e.g., "remote", "qemu", or "util.json" (the name in the filter can file, e.g., @samp{"remote"}, @samp{"qemu"}, or @samp{"util.json"} (the
be a substring of the full category name, in order to match multiple name in the filter can be a substring of the full category name, in
similar categories), the optional "+" prefix tells libvirt to log stack order to match multiple similar categories), the optional @samp{"+"}
trace for each message matching name, and @code{x} is the minimal level prefix tells libvirt to log stack trace for each message matching name,
where matching messages should be logged: and @code{x} is the minimal level where matching messages should be
logged:
@itemize @bullet @itemize @bullet
@item @item
@ -24141,7 +24144,7 @@ expose repositories over the Git protocol for anonymous access.
The optional @var{config} argument should be a The optional @var{config} argument should be a
@code{<git-daemon-configuration>} object, by default it allows read-only @code{<git-daemon-configuration>} object, by default it allows read-only
access to exported@footnote{By creating the magic file access to exported@footnote{By creating the magic file
"git-daemon-export-ok" in the repository directory.} repositories under @file{git-daemon-export-ok} in the repository directory.} repositories under
@file{/srv/git}. @file{/srv/git}.
@end deffn @end deffn
@ -24808,7 +24811,7 @@ Defaults to @samp{"a fast webinterface for the git dscm"}.
@deftypevr {@code{cgit-configuration} parameter} string root-readme @deftypevr {@code{cgit-configuration} parameter} string root-readme
The content of the file specified with this option will be included The content of the file specified with this option will be included
verbatim below the "about" link on the repository index page. verbatim below the ``about'' link on the repository index page.
Defaults to @samp{""}. Defaults to @samp{""}.
@ -24825,8 +24828,8 @@ Defaults to @samp{""}.
If set to @samp{#t} and repository-directory is enabled, If set to @samp{#t} and repository-directory is enabled,
repository-directory will recurse into directories whose name starts repository-directory will recurse into directories whose name starts
with a period. Otherwise, repository-directory will stay away from such with a period. Otherwise, repository-directory will stay away from such
directories, considered as "hidden". Note that this does not apply to directories, considered as ``hidden''. Note that this does not apply to
the ".git" directory in non-bare repos. the @file{.git} directory in non-bare repos.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@ -24889,7 +24892,7 @@ Defaults to @samp{""}.
@end deftypevr @end deftypevr
@deftypevr {@code{cgit-configuration} parameter} integer summary-branches @deftypevr {@code{cgit-configuration} parameter} integer summary-branches
Specifies the number of branches to display in the repository "summary" Specifies the number of branches to display in the repository ``summary''
view. view.
Defaults to @samp{10}. Defaults to @samp{10}.
@ -24898,14 +24901,14 @@ Defaults to @samp{10}.
@deftypevr {@code{cgit-configuration} parameter} integer summary-log @deftypevr {@code{cgit-configuration} parameter} integer summary-log
Specifies the number of log entries to display in the repository Specifies the number of log entries to display in the repository
"summary" view. ``summary'' view.
Defaults to @samp{10}. Defaults to @samp{10}.
@end deftypevr @end deftypevr
@deftypevr {@code{cgit-configuration} parameter} integer summary-tags @deftypevr {@code{cgit-configuration} parameter} integer summary-tags
Specifies the number of tags to display in the repository "summary" Specifies the number of tags to display in the repository ``summary''
view. view.
Defaults to @samp{10}. Defaults to @samp{10}.
@ -24997,7 +25000,7 @@ Defaults to @samp{""}.
@deftypevr {@code{repository-cgit-configuration} parameter} repo-string defbranch @deftypevr {@code{repository-cgit-configuration} parameter} repo-string defbranch
The name of the default branch for this repository. If no such branch The name of the default branch for this repository. If no such branch
exists in the repository, the first branch name (when sorted) is used as exists in the repository, the first branch name (when sorted) is used as
default instead. By default branch pointed to by HEAD, or "master" if default instead. By default branch pointed to by HEAD, or ``master'' if
there is no suitable HEAD. there is no suitable HEAD.
Defaults to @samp{""}. Defaults to @samp{""}.
@ -25158,7 +25161,7 @@ Defaults to @samp{""}.
@deftypevr {@code{repository-cgit-configuration} parameter} repo-string readme @deftypevr {@code{repository-cgit-configuration} parameter} repo-string readme
A path (relative to repo) which specifies a file to include verbatim as A path (relative to repo) which specifies a file to include verbatim as
the "About" page for this repo. the ``About'' page for this repo.
Defaults to @samp{""}. Defaults to @samp{""}.
@ -25297,7 +25300,7 @@ A value like @code{#o0027} will give read access to the group used by Gitolite
like cgit or gitweb. like cgit or gitweb.
@item @code{git-config-keys} (default: @code{""}) @item @code{git-config-keys} (default: @code{""})
Gitolite allows you to set git config values using the "config" keyword. This Gitolite allows you to set git config values using the @samp{config} keyword. This
setting allows control over the config keys to accept. setting allows control over the config keys to accept.
@item @code{roles} (default: @code{'(("READERS" . 1) ("WRITERS" . ))}) @item @code{roles} (default: @code{'(("READERS" . 1) ("WRITERS" . ))})