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

  • From: cyborg4k@xxxxxxxxx (Shaks)
  • Date: Mon, 26 Apr 2004 08:47:28 -0700 (PDT)

Hi!

Once we finish a handful set of man pages, we will
give you the link and you can check them out and give
your valuable comments on how we can improve it.

cluttering up a man page shouldn't be fruitful.  

We'll try to make it as legible as possible.

May
be examples can be
added at the end of the manpage.

Adding examples at the end of the manpage doesn't help
because one has to keep scrolling back and forth. This
becomes difficult when you have a man page of 1000
lines. 

Regards,

Shaks

=====
--------------------------------------------------------------------------
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

From Sajith T S <sajithts@xxxxxxxxxxxxx>  Mon Apr 26 17:48:22 2004
From: Sajith T S <sajithts@xxxxxxxxxxxxx> (Sajith T S)
Date: Mon, 26 Apr 2004 23:18:22 +0530
Subject: Re (3): [Ilugc] Volunteers? New man page doc project
In-Reply-To: <20040426154728.45360.qmail@xxxxxxxxxxxxxxxxxxxxxxx>
References: <20040426154728.45360.qmail@xxxxxxxxxxxxxxxxxxxxxxx>
Message-ID: <408D4B66.100@xxxxxxxxxxxxx>

Shaks wrote:

Adding examples at the end of the manpage doesn't help
because one has to keep scrolling back and forth. This
becomes difficult when you have a man page of 1000
lines. 

Isn't that one of the reasons we have info pages?

I think you should be considering DocBook XML for documentation - you
can choose man, info, HTML, rich text format or plain text output after
preparing the documentation proper and marking them up (or mark-upping
them?)

Sajith.
-- 
Your friends will know you better in the first moment you meet than
your acquaintances will know you in a lifetime.
                    -- Richard Bach, "Illusions"



Other related posts:

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