Re(2): [Ilugc] Volunteers? New man page doc project

  • From: cyborg4k@xxxxxxxxx (Shaks)
  • Date: Sun, 25 Apr 2004 15:50:40 -0700 (PDT)

Hi!

Thanks for the reply. Basically the man pages have
already been written in the default file format. We
only have to add as many examples as possible to
illustrate the usage of the command.

1/ 
First, you have to read on how to write a man page and
become familiar with the tags. Check these links:
http://www.justlinux.com/nhf/Miscellaneous/Creating_Your_Man_Page.html
http://www.schweikhardt.net/man_page_howto.html
http://www.faqs.org/docs/Linux-mini/Man-Page.html
http://gmanedit.sourceforge.net/man7.html

The man pages are already present in /usr/share/man,
and in the directories within. To find out where the
documentation page for say "less" is, just do,
#whereis less
For example, in my system it is in
/usr/share/man/man1/less.1.gz. You can use online man
pages, but, it will be a pain converting them to the
standard man page format. So, let's just use the
existing man pages and add the examples.

2/
Extract the .gz file using:
#gunzip less.1.gz

3/
You can then edit the file (using any editor, vim or
emacs or any other) with examples for each option and
wherever necessary. You can use online documentation
or examples from books to provide the necessary
examples.

4/
Check the newly modified man page using:
#nroff -man -Tascii less.1 | less

We will then make a schedule and work on the commands.
We can move the discussion to private email from now
on. This will be a continous work-in-progress. We can
each do like 3 commands/week depending on work and
time.

Cheers,

Shaks

- praveen  shankar <praveenr_s@xxxxxxxxxxxxxx> wrote:

Hi Shanks,
Yes, I am Interested in writing man page even i find
diff''' to work it.....
Mail me what is the next step...
Praveen S
Chennai..


=====
--------------------------------------------------------------------------
Gentoo Linux 1.4 (2.6.5-mm1) / FreeBSD Unix 4.9 - Pentium M 1.40GHz - 512 MB - 
40 GB - 14" - 4.5-4.9 lbs - CD-RW/DVD-ROM - Intel PRO/1000 Gigabit Ethernet - 
Intel PRO/Wireless Network Connection 802.11b
                                                  http://www.rit.edu/~sak5991
--------------------------------------------------------------------------


        
                
__________________________________
Do you Yahoo!?
Yahoo! Photos: High-quality 4x6 digital prints for 25¢
http://photos.yahoo.com/ph/print_splash

Other related posts:

  • » Re(2): [Ilugc] Volunteers? New man page doc project - Shaks