Red Hat Bugzilla – Bug 147076
RFE: Turn sysconfig.txt into man pages for config files.
Last modified: 2013-09-04 10:49:48 EDT
Description of problem:
This is an old one, but I can't find it in bugzilla. Many customers
have griped about the lack of man pages for /etc/sysconfig for years.
As an instructor, I find most customers aren't aware that
/usr/share/doc/initscripts*/sysconfig.txt exists. Nor should they be -
the format of configuration files have always been documented in
section 5 of the manual. /usr/share/doc is typically used for READMEs
and task based documentation. The initscripts package is the only well
man 5 init
If you like, I can even write these myself (I have a little experience
- I wrote man resolv.conf in RHEL 4).
Sure, taking patches. :)
Moving to FC devel; this isn't something that would be backported to RHEL 3/RHEL 4.
Created attachment 119063 [details]
Created attachment 119065 [details]
chapter 5 network
Hm. I wonder if switching the whole thing over to docbook and building the man
pages from that (and the text) would work.
Totally, and I agree that'd be the best approach.
I'm not on documentation team, though, I don't know docbook, and the priority is
getting sysconfig documented properly from a customer POV, not a RH engineering POV.
Ah, you mean switching sysconfig.txt over to docbook?
It needs editing. Not all options are documented and not all are documented
properly. There are no examples.
If docs team want to handle this instead of me, I'd be delighted. I've got RH300
courseware to rewrite.
*** Bug 58381 has been marked as a duplicate of this bug. ***
Created attachment 588460 [details]
minimal ifcfg man page
This is a minimal ifcfg man page just referring to sysconfig.txt for the detailed description.
Comment on attachment 119063 [details]
Re. attachment in comment #4
"ethernet" should be written "Ethernet" in the descriptions.
Comment on attachment 119065 [details]
chapter 5 network
Re. comment #5
s/IPv6 packes/IPv6 packets/
This package has changed ownership in the Fedora Package Database. Reassigning to the new owner of this component.