[arch-projects] rc.conf documentation
Hi, rc.conf is a bit documented in several places: 1) in rc.conf itself, although documentation there is a bit limited (not always explaining what things are for exactly) but it does contain stuff like examples for networking. 2) in the official installation guide, which has historically been more extensive in describing what things are for and how to make your choice, although it lags behind because it is not tightly coupled to rc.conf, usually I update it when I notice (or somebody tells me) it's out of date. 3) https://wiki.archlinux.org/index.php/Rc.conf which is similar to (2) but with a few more tips, it seems to be maintained by the community. Also I notice there is no manpage for rc.conf. How can we improve this situation? Maybe by maintaining a man page for rc.conf which is as extensive as what currently in the official install guide? then, in the official installation guide, I can just refer to the rc.conf manpage, meaning the documentation is always in sync, at the same time it would also allow to make the documentation in rc.conf a bit more minimal. Dieter
Hi Dieter, On Sun, Dec 25, 2011 at 3:18 PM, Dieter Plaetinck <dieter@plaetinck.be> wrote:
Also I notice there is no manpage for rc.conf. How can we improve this situation? Maybe by maintaining a man page for rc.conf which is as extensive as what currently in the official install guide? then, in the official installation guide, I can just refer to the rc.conf manpage, meaning the documentation is always in sync, at the same time it would also allow to make the documentation in rc.conf a bit more minimal.
Thanks for caring about this. I think a manpage would make the most sense. I try to update the wiki when i remember, but I definitely have forgotten in the past. A manpage would be much simpler to keep up to date (as we'd change the documentation when we commit the change to the code, rather than when the code is released). If anyone would like to work on this I'd be very happy. Otherwise, I'd put it on my TODO list... Cheers, Tom
On Sun, 25 Dec 2011 16:55:23 +0100 Tom Gundersen <teg@jklm.no> wrote:
Hi Dieter,
On Sun, Dec 25, 2011 at 3:18 PM, Dieter Plaetinck <dieter@plaetinck.be> wrote:
Also I notice there is no manpage for rc.conf. How can we improve this situation? Maybe by maintaining a man page for rc.conf which is as extensive as what currently in the official install guide? then, in the official installation guide, I can just refer to the rc.conf manpage, meaning the documentation is always in sync, at the same time it would also allow to make the documentation in rc.conf a bit more minimal.
Thanks for caring about this.
I think a manpage would make the most sense. I try to update the wiki when i remember, but I definitely have forgotten in the past. A manpage would be much simpler to keep up to date (as we'd change the documentation when we commit the change to the code, rather than when the code is released).
If anyone would like to work on this I'd be very happy. Otherwise, I'd put it on my TODO list...
Cheers,
Tom
Well, I can help. I'm working on a new archiso release and for that I need up to date rc.conf docs (well, need is a big word. let's say it helps me making our users a bit happier) if somebody has a basic manpage template I can help fill in blanks / make corrections etc. most of the content is already available at https://github.com/Dieterbe/aif/blob/develop/doc/official_installation_guide... and http://projects.archlinux.org/initscripts.git/tree/rc.conf but I just need a starting point. I tried using rc.d.8.txt as starting point but I fail: 18:05:22 dieter@Gi tmp master ? curl http://projects.archlinux.org/initscripts.git/tree/rc.d.8.txt > rc.d.8.txt % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 11607 0 11607 0 0 39969 0 --:--:-- --:--:-- --:--:-- 69921 18:05:29 dieter@Gi tmp master ? a2x -d manpage -f manpage rc.d.8.txt a2x: ERROR: /usr/bin/asciidoc.py --backend docbook -a a2x-format=manpage --doctype manpage --out-file /home/dieter/tmp/rc.d.8.xml /home/dieter/tmp/rc.d.8.txt returned non-zero exit status 1 18:05:45 dieter@Gi tmp master ? pacman -Qo a2x 1 ↵ /usr/bin/a2x is owned by asciidoc 8.6.6-2 Dieter
On Sun, 25 Dec 2011 18:07:21 +0100 Dieter Plaetinck <dieter@plaetinck.be> wrote:
On Sun, 25 Dec 2011 16:55:23 +0100 Tom Gundersen <teg@jklm.no> wrote:
Hi Dieter,
On Sun, Dec 25, 2011 at 3:18 PM, Dieter Plaetinck <dieter@plaetinck.be> wrote:
Also I notice there is no manpage for rc.conf. How can we improve this situation? Maybe by maintaining a man page for rc.conf which is as extensive as what currently in the official install guide? then, in the official installation guide, I can just refer to the rc.conf manpage, meaning the documentation is always in sync, at the same time it would also allow to make the documentation in rc.conf a bit more minimal.
Thanks for caring about this.
I think a manpage would make the most sense. I try to update the wiki when i remember, but I definitely have forgotten in the past. A manpage would be much simpler to keep up to date (as we'd change the documentation when we commit the change to the code, rather than when the code is released).
If anyone would like to work on this I'd be very happy. Otherwise, I'd put it on my TODO list...
Cheers,
Tom
Well, I can help. I'm working on a new archiso release and for that I need up to date rc.conf docs (well, need is a big word. let's say it helps me making our users a bit happier) if somebody has a basic manpage template I can help fill in blanks / make corrections etc. most of the content is already available at https://github.com/Dieterbe/aif/blob/develop/doc/official_installation_guide... and http://projects.archlinux.org/initscripts.git/tree/rc.conf but I just need a starting point.
I tried using rc.d.8.txt as starting point but I fail:
18:05:22 dieter@Gi tmp master ? curl http://projects.archlinux.org/initscripts.git/tree/rc.d.8.txt > rc.d.8.txt % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 11607 0 11607 0 0 39969 0 --:--:-- --:--:-- --:--:-- 69921 18:05:29 dieter@Gi tmp master ? a2x -d manpage -f manpage rc.d.8.txt a2x: ERROR: /usr/bin/asciidoc.py --backend docbook -a a2x-format=manpage --doctype manpage --out-file /home/dieter/tmp/rc.d.8.xml /home/dieter/tmp/rc.d.8.txt returned non-zero exit status 1 18:05:45 dieter@Gi tmp master ? pacman -Qo a2x 1 ↵ /usr/bin/a2x is owned by asciidoc 8.6.6-2
Dieter
this was PEBKAC. i downloaded the html page instead of plain source of the manpage. i seem to be able to compile manpages now. stay tuned... Dieter
Here is a first version. http://pastie.org/3074109 based on contents of rc.conf itself and the official installation guide. compiles fine, but haven't been able to view this properly as a manpage yet. `man -l rc.conf` looks like junk (as does `man -l rc.d` so I must be doing something wrong. Dieter
On Mon, Dec 26, 2011 at 9:57 AM, Dieter Plaetinck <dieter@plaetinck.be> wrote:
Here is a first version. http://pastie.org/3074109 based on contents of rc.conf itself and the official installation guide. compiles fine, but haven't been able to view this properly as a manpage yet. `man -l rc.conf` looks like junk (as does `man -l rc.d` so I must be doing something wrong.
Thanks for the man-page. It still has some formatting errors (I never looked into how this format we are using works, so haven't been able to fix it yet), but I thought I'd push it out so people can use it as a base for contributions. Cheers, Tom
participants (2)
-
Dieter Plaetinck
-
Tom Gundersen