Creating a Man page for a command

#1 (**permalink**) 12-18-2008

Hi,

I would like to develop a man page as the one we usually get when we execute man <command name>. This man page will be for a samll utility that i have written.

If this is not possible then what are the available possibilites for creating such help.

thanks in advance.

Perderabo · #2 (**permalink**) 12-21-2008

Well, you should put your utility somewhere like /usr/local/bin and then put your man page somewhere in /usr/local/man. Then if you set the MANPATH variable to include /usr/local/man it should work. Find some man page you like and copy its source code to your man page and then just edit the text to describe your utility.

drl · #3 (**permalink**) 12-21-2008

Hi.

I think I have used txt2man a few times. There are repositories that contain it, but you may be able to get it at the URL below.

There are a number of similar utilities -- depends on how much you want to search, download, install, try, etc ... cheers, drl

Quote:

txt2man

Txt2man converts flat ASCII text to man page format. It is a shell script using gnu awk, that should run on any Unix like system. Last version: 1.5.5 (21-mar-2007) ...

http://mvertes.free.fr/

More UNIX and Linux Forum Topics You Might Find Helpful
Thread	Thread Starter	Forum	Replies	Last Post
High Page In and Executable page In	srage	SUN Solaris	9	11-17-2008 09:52 PM
S-214: SurgeMail and WebMail 'Page' Command Vulnerability	iBot	Security Advisories (RSS)	0	02-27-2008 05:40 PM
creating a new profile from command line	cleansing_flame	OS X (Apple)	2	12-03-2007 09:57 PM
creating file of 1MB using shell command?	vijaya2006	Shell Programming and Scripting	4	04-04-2006 08:47 AM
view page command?	JaredsNew	UNIX for Dummies Questions & Answers	3	07-17-2003 12:48 AM

Thread Tools	Search this Thread
Show Printable Version Email this Page	Search this Thread: Advanced Search
Display Modes	Rate This Thread
Switch to Linear Mode Hybrid Mode Switch to Threaded Mode	Rate This Thread:


	Powered by