LinuxQuestions.org
Download your favorite Linux distribution at LQ ISO.
Go Back   LinuxQuestions.org > Forums > Linux Forums > Linux - General
User Name
Password
Linux - General This Linux forum is for general Linux questions and discussion.
If it is Linux Related and doesn't seem to fit in any other forum then this is the place.

Notices



Reply
 
Search this Thread
Old 08-26-2010, 02:18 PM   #1
Hi_This_is_Dev
Member
 
Registered: May 2009
Location: India
Distribution: On my PC I use RHEL, at office AIX, Solaris, HP-UX, RHEL.
Posts: 254

Rep: Reputation: 18
Create a Manual / Man Page for a Script or Tool


Hi,


How do we create and link a manual / man page to man command?

To illustrate my point, kindly consider the following:


Code:
-bash-2.05b# ls
case.sh  scriptPid.sh
-bash-2.05b# man case.sh
No manual entry for case.sh
-bash-2.05b#

As you can see that I have two scripts. I want to display a manual / man page for the scripts. How to achieve it?

For the time being I have done this:


Code:
-bash-2.05b# sh case.sh --help
No help document is available at this time.
-bash-2.05b#


That is writing related information in the script itself.
 
Old 08-26-2010, 02:33 PM   #2
rikijpn
Member
 
Registered: Jun 2007
Location: Japan
Distribution: Debian lenny, DSL, Solaris 10
Posts: 157

Rep: Reputation: 33
If it's an extensive manual you may want to better write an info file.
If it's very short, you should just put it in the script...

Anyway, a quick google search returned this , it's kinda long, so you may want to read a short page I wrote some time ago.

If you are writing a very serious/technical manual, you should probably search for "groff" which is the formatting language used in man pages.
 
  


Reply

Tags
help, man, manual


Thread Tools Search this Thread
Search this Thread:

Advanced Search

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
[SOLVED] I can know the length in lines of a man page but not of an info manual. stf92 Linux - Newbie 3 12-10-2009 03:41 AM
[SOLVED] how can i create manual for my script? a.toraby Programming 8 11-26-2009 07:48 AM
[SOLVED] Need Python or Perl script to create a default web page on hosting site chilali Linux - Server 2 08-03-2009 06:41 AM
create a shell script to do simple man lookup jCash Linux - Newbie 5 01-24-2008 10:51 AM
man alsamixer not showing the man page nosaku Slackware 1 12-20-2004 09:52 AM


All times are GMT -5. The time now is 02:10 AM.

Main Menu
Advertisement
My LQ
Write for LQ
LinuxQuestions.org is looking for people interested in writing Editorials, Articles, Reviews, and more. If you'd like to contribute content, let us know.
Main Menu
Syndicate
RSS1  Latest Threads
RSS1  LQ News
Twitter: @linuxquestions
identi.ca: @linuxquestions
Facebook: linuxquestions Google+: linuxquestions
Open Source Consulting | Domain Registration