diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2014-07-26 08:29:03 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2014-07-26 08:29:03 +0300 |
commit | 6e7bbc2eb158ab7f35cc019a77b0c254c74125f1 (patch) | |
tree | 14843f2f9955efa2f71771307f7c1dae080411d5 | |
parent | 639fd46fac8108305a02bdc95aaa3923034d798c (diff) | |
download | pam-modules-6e7bbc2eb158ab7f35cc019a77b0c254c74125f1.tar.gz pam-modules-6e7bbc2eb158ab7f35cc019a77b0c254c74125f1.tar.bz2 |
Improve docstrings in examples.
-rwxr-xr-x | examples/ldappubkey | 16 | ||||
-rwxr-xr-x | examples/usergitconfig | 17 |
2 files changed, 32 insertions, 1 deletions
diff --git a/examples/ldappubkey b/examples/ldappubkey index 6073e73..d631a82 100755 --- a/examples/ldappubkey +++ b/examples/ldappubkey | |||
@@ -34,6 +34,8 @@ on a separate line. The program is designed for use with B<sshd>(8) version | |||
34 | configuration is looked up in the following files: B</etc/ldap.conf>, | 34 | configuration is looked up in the following files: B</etc/ldap.conf>, |
35 | B</etc/ldap/ldap.conf> and B</etc/openldap/ldap.conf>. These files are | 35 | B</etc/ldap/ldap.conf> and B</etc/openldap/ldap.conf>. These files are |
36 | tried in this order and the first one of them that exists is read. | 36 | tried in this order and the first one of them that exists is read. |
37 | If the environment variable B<LDAP_CONF> is defined, the file it points | ||
38 | to is tried first. | ||
37 | 39 | ||
38 | The following configuration statements are used (all keywords are | 40 | The following configuration statements are used (all keywords are |
39 | case-insensitive): | 41 | case-insensitive): |
@@ -116,6 +118,20 @@ Show detailed help page. | |||
116 | 118 | ||
117 | =back | 119 | =back |
118 | 120 | ||
121 | =head1 ENVIRONMENT | ||
122 | |||
123 | =over 4 | ||
124 | |||
125 | =item B<LDAP_CONF> | ||
126 | |||
127 | If defined, names the alternative configuration file to read. | ||
128 | |||
129 | =item B<GITCONFIG_TEMPLATE> | ||
130 | |||
131 | Name of the template file to use instead of the default B<.gitconfig>. | ||
132 | |||
133 | =back | ||
134 | |||
119 | =head1 SEE ALSO | 135 | =head1 SEE ALSO |
120 | 136 | ||
121 | B<sshd>(8), B<sshd_config>(5), B<ldap.conf>(5). | 137 | B<sshd>(8), B<sshd_config>(5), B<ldap.conf>(5). |
diff --git a/examples/usergitconfig b/examples/usergitconfig index 8199051..4748e9f 100755 --- a/examples/usergitconfig +++ b/examples/usergitconfig | |||
@@ -36,7 +36,8 @@ attribute, an empty value is substituted. | |||
36 | The program reads its configuration from one of the following files: | 36 | The program reads its configuration from one of the following files: |
37 | B</etc/ldap.conf>, B</etc/ldap/ldap.conf> and B</etc/openldap/ldap.conf>. | 37 | B</etc/ldap.conf>, B</etc/ldap/ldap.conf> and B</etc/openldap/ldap.conf>. |
38 | These files are tried in this order and the first one of them that exists | 38 | These files are tried in this order and the first one of them that exists |
39 | is read. | 39 | is read. If the environment variable B<LDAP_CONF> is defined, the file it |
40 | points to is tried first. | ||
40 | 41 | ||
41 | The following configuration statements are used: | 42 | The following configuration statements are used: |
42 | 43 | ||
@@ -117,7 +118,21 @@ Example B<.gitconfig> file: | |||
117 | name = ${cn} | 118 | name = ${cn} |
118 | email = ${mail} | 119 | email = ${mail} |
119 | 120 | ||
121 | |||
122 | =head1 ENVIRONMENT | ||
123 | |||
124 | =over 4 | ||
125 | |||
126 | =item B<LDAP_CONF> | ||
127 | |||
128 | If defined, names the alternative configuration file to read. | ||
129 | |||
130 | =item GITCONFIG_TEMPLATE | ||
131 | |||
132 | Name of the template file to use instead of the default B<.gitconfig>. | ||
120 | 133 | ||
134 | =back | ||
135 | |||
121 | =head1 SEE ALSO | 136 | =head1 SEE ALSO |
122 | 137 | ||
123 | B<pam_ldaphome>(8), B<ldap.conf>(5). | 138 | B<pam_ldaphome>(8), B<ldap.conf>(5). |