add manpage for the module
[pam_pcsc_cr.git] / pam_cr_setup.8
index 24170646e787ddbbd1f42c0d2661c7c5e9a028b4..d09f4452e6ab17f1952afbac2681b28cd838c645 100644 (file)
@@ -38,7 +38,7 @@ necessary.
 .SH OPTIONS
 .B \-h
 \- show short description and exit.
 .SH OPTIONS
 .B \-h
 \- show short description and exit.
-.sp
+.PP
 .B \-o backend-option
 \- option specific to the crypto-token.
 The format is
 .B \-o backend-option
 \- option specific to the crypto-token.
 The format is
@@ -46,14 +46,14 @@ The format is
 At present, only Yubikey Neo
 crypto-token is supported, and the only option is
 .B ykneo:slot=[1|2].
 At present, only Yubikey Neo
 crypto-token is supported, and the only option is
 .B ykneo:slot=[1|2].
-.sp
+.PP
 .B \-f template
 \- template for the auth file path. It may contain one character
 .B '~'
 which, if in the first position, is replaced with the userid's
 home directory path, and if in any other position - with the userid
 itself.
 .B \-f template
 \- template for the auth file path. It may contain one character
 .B '~'
 which, if in the first position, is replaced with the userid's
 home directory path, and if in any other position - with the userid
 itself.
-.sp
+.PP
 .B \-a secret
 or
 .B \-A file-with-secret
 .B \-a secret
 or
 .B \-A file-with-secret
@@ -65,12 +65,12 @@ the payload in the absense of the crypto-token.
 .B \-A -
 means that the 40-character string is read from
 .B stdin.
 .B \-A -
 means that the 40-character string is read from
 .B stdin.
-.sp
+.PP
 .B \-n nonce
 \- initial nonce. Currently this must be a decimal representation of an
 integer. It is subsequently incremented by one on every successful
 authentication session.
 .B \-n nonce
 \- initial nonce. Currently this must be a decimal representation of an
 integer. It is subsequently incremented by one on every successful
 authentication session.
-.sp
+.PP
 .B \-l payload
 \- a string that will be injected into the PAM framework as
 .B AUTH_TOKEN
 .B \-l payload
 \- a string that will be injected into the PAM framework as
 .B AUTH_TOKEN
@@ -78,7 +78,7 @@ upon successful authentication. It is useful to have the keyring
 unlock password there. The payload is encrypted in the file, and only
 exists in memory in decrypted form for a short period (unless leaked
 by other PAM modules).
 unlock password there. The payload is encrypted in the file, and only
 exists in memory in decrypted form for a short period (unless leaked
 by other PAM modules).
-.sp
+.PP
 .B \-p password
 \- login password that is used to create the challenge (not the one
 from
 .B \-p password
 \- login password that is used to create the challenge (not the one
 from
@@ -89,15 +89,15 @@ module uses when invoked with
 .B noaskpass
 argument. With empty password, login process requires only the presence
 of the crypto-token, and does not involve any input from the user.
 .B noaskpass
 argument. With empty password, login process requires only the presence
 of the crypto-token, and does not involve any input from the user.
-.sp
+.PP
 .B \-v
 \- output the userid and payload from the auth file. Note that displaying
 the payload on screen to be seen by passers by may not be a good idea.
 .B \-v
 \- output the userid and payload from the auth file. Note that displaying
 the payload on screen to be seen by passers by may not be a good idea.
-.sp
+.PP
 
 .SH COPYRIGHT
 2013 Eugene G. Crosser
 .br
 Released under zlib Open Source license.
 .SH SEE ALSO
 
 .SH COPYRIGHT
 2013 Eugene G. Crosser
 .br
 Released under zlib Open Source license.
 .SH SEE ALSO
-.BR pam "(3), "ykpersonalize "(1)
+.BR pam "(3), "ykpersonalize "(1), "pam_pcsc_cr "(8)