diff options
author | Jeff Layton <jlayton@samba.org> | 2017-10-23 13:46:33 -0400 |
---|---|---|
committer | Jeff Layton <jlayton@samba.org> | 2017-10-23 13:46:33 -0400 |
commit | 72c68f598ccd935ba1c11c7e64d68e9d094bb1ac (patch) | |
tree | 27bbb4d22e857d9ed4efd5f8b4ca43c81c7137cc /cifscreds.rst | |
parent | d999610bf985f19fcc1984be95f11da7a3e88533 (diff) | |
download | cifs-utils-72c68f598ccd935ba1c11c7e64d68e9d094bb1ac.tar.gz cifs-utils-72c68f598ccd935ba1c11c7e64d68e9d094bb1ac.tar.bz2 cifs-utils-72c68f598ccd935ba1c11c7e64d68e9d094bb1ac.zip |
doc: convert pod files to rst
Aurelien did a big conversion of raw troff files into .pod docs in a
recent patch. That worked out pretty well, but I have some reservations
about using POD as a canonical format.
While it does make it pretty simple to write manpages, it's sort of an
obscure format, and is heavily associated with perl. Meanwhile, the
kernel is slowly moving to using ReStructured Text as its documentation
format. Given the simplicity of the cifs-utils manpages, I think we're
better suited to using rst as a canonical format, rather than pod.
This patch converts all of the .pod files in the code to .rst files,
and fixes the Makefile and autoconf to use the correct tools to turn
those into manpages.
The conversion was done with the pod2rst script, with some by-hand
modifications at the end to clean up the formatting and add the manual
section numbers. It's not perfect and could probably use a second pass
to clean up the warts in the formatting, but the content is all intact
and it should be readable.
Finally, convert the makefile rules to use standard SUFFIX rules
instead of the non-portable GNU make % style extension rules. We don't
really expect anyone to use anything other than GNU make here, but
this silences an automake warning.
Signed-off-by: Aurelien Aptel <aaptel@suse.com>
Signed-off-by: Jeff Layton <jlayton@samba.org>
Diffstat (limited to 'cifscreds.rst')
-rw-r--r-- | cifscreds.rst | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/cifscreds.rst b/cifscreds.rst new file mode 100644 index 0000000..5c2a195 --- /dev/null +++ b/cifscreds.rst @@ -0,0 +1,129 @@ +========= +cifscreds +========= + +----------------------------------------- +manage NTLM credentials in kernel keyring +----------------------------------------- + +:Manual section: 1 + +******** +SYNOPSIS +******** + + +cifscreds add|clear|clearall|update [-u username] [-d] host|domain + + +*********** +DESCRIPTION +*********** + + +The \ **cifscreds**\ program is a tool for managing credentials (username +and password) for the purpose of establishing sessions in multiuser +mounts. + +When a cifs filesystem is mounted with the "multiuser" option, and does +not use krb5 authentication, it needs to be able to get the credentials +for each user from somewhere. The \ **cifscreds**\ program is the tool used +to provide these credentials to the kernel. + +The first non-option argument to cifscreds is a command (see the +\ **COMMANDS**\ section below). The second non-option argument is a hostname +or address, or an NT domain name. + + +******** +COMMANDS +******** + + + +\ **add**\ + + Add credentials to the kernel to be used for connecting to the given server, or servers in the given domain. + + + +\ **clear**\ + + Clear credentials for a particular host or domain from the kernel. + + + +\ **clearall**\ + + Clear all cifs credentials from the kernel. + + + +\ **update**\ + + Update stored credentials in the kernel with a new username and + password. + + + + +******* +OPTIONS +******* + + + +\ **-d**\ , \ **--domain**\ + + The provided host/domain argument is a NT domainname. + + Ordinarily the second argument provided to cifscreds is treated as a + hostname or IP address. This option causes the cifscreds program to + treat that argument as an NT domainname instead. + + If there are not host specific credentials for the mounted server, then + the kernel will next look for a set of domain credentials equivalent to + the domain= option provided at mount time. + + + +\ **-u**\ , \ **--username**\ + + Ordinarily, the username is derived from the unix username of the user + adding the credentials. This option allows the user to substitute a + different username. + + + + +***** +NOTES +***** + + +The cifscreds utility requires a kernel built with support for the +\ **login**\ key type. That key type was added in v3.3 in mainline Linux +kernels. + +Since \ **cifscreds**\ adds keys to the session keyring, it is highly +recommended that one use \ **pam_keyinit**\ to ensure that a session keyring +is established at login time. + + +******** +SEE ALSO +******** + + +pam_keyinit(8) + + +******* +AUTHORS +******* + + +The cifscreds program was originally developed by Igor Druzhinin +<jaxbrigs@gmail.com>. This manpage and a redesign of the code was done +by Jeff Layton <jlayton@samba.org>. + |