#55: Create an environment.5 man page link to pam_env.8 -----------------------+------------------------------ Reporter: mkerrisk | Owner: pam-developers@… Type: defect | Status: new Priority: major | Component: library Version: | Keywords: Blocked By: | Blocking: -----------------------+------------------------------ It seems that many people are confused[1] about the /etc/environment file, mainly because they cannot find a man page for it. The file is of course documented in the pam_env(8) manual page, but people have a hard time working that out. It would be helpful if there was a "man page link" called environment.5 that linked to pam_env.8 (i.e., environment.5 containing ".so man8/pam_env.8"). Could you add such a link as part of the package please?
While we're here, could I also suggest adding an entry "environ(7)" under "SEE ALSO" in the pam_env(8) man page? (I just added the reverse link in environment.7 in the man-pages package that I maintain.)
Thanks,
Michael
[1] Examples: http://askubuntu.com/questions/149661/pointers-with-syntax-in-etc- environment/149668#149668 http://superuser.com/questions/339617/how-to-reload-etc-environment- without-rebooting http://superuser.com/questions/664169/what-is-the-difference-betwen-etc- environment-and-etc-profile http://askubuntu.com/questions/150789/difference-between-bash-bashrc-and- etc-environment-file
#55: Create an environment.5 man page link to pam_env.8 ---------------------+------------------------------- Reporter: mkerrisk | Owner: pam-developers@… Type: defect | Status: new Priority: major | Component: library Version: | Resolution: Keywords: | Blocked By: Blocking: | ---------------------+-------------------------------
Comment (by mkerrisk):
And one more example of user confusion, which was the one that triggered this report: https://bugs.launchpad.net/ubuntu/+source/manpages/+bug/18574
See also https://bugs.launchpad.net/ubuntu/+source/manpages/+bug/18574/comments/17
#55: Create an environment.5 man page link to pam_env.8 ---------------------+------------------------------- Reporter: mkerrisk | Owner: pam-developers@… Type: defect | Status: closed Priority: major | Component: documentation Version: | Resolution: fixed Keywords: | Blocked By: Blocking: | ---------------------+------------------------------- Changes (by tmraz):
* status: new => closed * resolution: => fixed * component: library => documentation
Comment:
As it was not possible to create environment.5 as link to pam_env(8), I've added a paragraph about /etc/environment to the pam_env.conf(5) and created the environment.5 as link to this page. I've also added the environ(7) reference.
#55: Create an environment.5 man page link to pam_env.8 ---------------------+------------------------------- Reporter: mkerrisk | Owner: pam-developers@… Type: defect | Status: closed Priority: major | Component: documentation Version: | Resolution: fixed Keywords: | Blocked By: Blocking: | ---------------------+-------------------------------
Comment (by mkerrisk):
Thanks, but I'm puzzled. If it's possible to make a link to pam- env.conf(5), why is it not possible to link to pam_env.8 instead? The latter makes sense, and that page already documents /etc/environment.
#55: Create an environment.5 man page link to pam_env.8 ---------------------+------------------------------- Reporter: mkerrisk | Owner: pam-developers@… Type: defect | Status: closed Priority: major | Component: documentation Version: | Resolution: fixed Keywords: | Blocked By: Blocking: | ---------------------+-------------------------------
Comment (by tmraz):
Because it is from different man volume and the docbook we use for generating the man pages does not support that. Of course I could add the link directly to the sources however I preferred more clean solution. I simply duplicated the information from pam_env.8 about /etc/environment to pam_env.conf.5
pam-developers@lists.fedorahosted.org