1 files changed, 87 insertions, 0 deletions
diff --git a/cifscreds.pod b/cifscreds.pod
new file mode 100644
index 0000000..17e453f
--- /dev/null
+++ b/cifscreds.pod
@@ -0,0 +1,87 @@
+# turn into a manpage with the following command:
+#
+# pod2man -s 1 -c '' -r '' --stderr cifscreds.pod > cifscreds.1
+#
+
+=head1 NAME
+
+cifscreds - manage NTLM credentials in kernel keyring
+
+=head1 SYNOPSIS
+
+cifscreds add|clear|clearall|update [-u username] [-d] host|domain
+
+=head1 DESCRIPTION
+
+The B<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 B<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
+B<COMMANDS> section below). The second non-option argument is a hostname
+or address, or an NT domain name.
+
+=head1 COMMANDS
+
+=over
+
+=item B<add>
+
+Add credentials to the kernel to be used for connecting to the given server, or servers in the given domain.
+
+=item B<clear>
+
+Clear credentials for a particular host or domain from the kernel.
+
+=item B<clearall>
+
+Clear all cifs credentials from the kernel.
+
+=item B<update>
+
+Update stored credentials in the kernel with a new username and
+password.
+
+=back
+
+=head1 OPTIONS
+
+=over
+
+=item B<-d>, B<--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.
+
+=item B<-u>, B<--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.
+
+=back
+
+=head1 NOTES
+
+The cifscreds utility requires a kernel built with support for the
+B<login> key type. That key type was added in v3.3 in mainline Linux
+kernels.
+
+=head1 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>.
+