Creating a Man page for a command


 
Thread Tools Search this Thread
Operating Systems Solaris Creating a Man page for a command
# 1  
Old 12-18-2008
Java Creating a Man page for a command

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.
raghu.amilineni
# 2  
Old 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.
# 3  
Old 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/
Login or Register to Ask a Question

Previous Thread | Next Thread

9 More Discussions You Might Find Interesting

1. Shell Programming and Scripting

Description of the option print0 in the command find (man page)

This is the description of the option -print0 fon the command find in the man page: What does the "True" in the first line of the description mean? (3 Replies)
Discussion started by: puertas12
3 Replies

2. UNIX for Dummies Questions & Answers

man page in MANPATH not found

dear unix experts, the 'man' command on my system isn't finding a manpage that is in a MANPATH directory, or even when I specify the path directly: 12:56pm ilya@node1390 /idi/sabetilab/ilya/usr/share/man $ man -M . xemacs No manual entry for xemacs 12:56pm ilya@node1390... (4 Replies)
Discussion started by: notestaff
4 Replies

3. Solaris

man page question

What does the last change means in man page .. does that this man page has not been updated since 2003 or something else ? newfs-options The options are documented in the newfs man page. SunOS 5.10 Last change: 9 Dec 2003 1 System... (2 Replies)
Discussion started by: fugitive
2 Replies

4. UNIX for Dummies Questions & Answers

Creating Custom man Page in Solaris

Hello experts, I'm creating a custom man page. I have two unix boxes - one Hp & the other Solaris On HP, I simply moved the .Z file to /usr/man/man7.Z/ and after that "man myPage" worked. I then tried to do the same on Solaris. First thing is the relevant directory seemed to be... (1 Reply)
Discussion started by: sridhar_423
1 Replies

5. Solaris

Unable to get help from man page

Help, it seem that i am unable to get man help form solaris 10. I am running SunOS unknown 5.10 Generic_120012-14 i86pc i386 i86pc when ever i try to man a command what i get is "No manual entry" like the one below. # man grep No manual entry for grep. # man ls No manual entry for ls.... (8 Replies)
Discussion started by: ezsurf
8 Replies

6. UNIX for Advanced & Expert Users

man page issue

Man page is not working my system. It is giving the following the following error > man ls gdbm fatal: read error with debug option > man -d ls ... .... ... ... using less as pager checking for locale en_US add_nls_manpath(): processing /usr/local/man:/usr/share/man:/usr/X11R6/man... (4 Replies)
Discussion started by: praveenkumar_l
4 Replies

7. Red Hat

scp-1.2.27 man page

Hi Guys, I'm looking for the man page for scp version 1.2.27 I have an old redhat server that has a few large scripts that use this version and I want to know what the -A flag does and the man page is not on there. (4 Replies)
Discussion started by: Tornado
4 Replies

8. UNIX for Dummies Questions & Answers

adding a man page

I was wonderiong if ther is a way for a user to add a man page specific to thier account. similar to copying the .1 or .1.gz to /usr/share/man/man1 "cp *.1.gz /usr/share/man/man1". Except for using another folder as I don't have access to /usr/share/man/man1. I would think that this might involve... (1 Reply)
Discussion started by: jacob358
1 Replies

9. UNIX for Dummies Questions & Answers

how do you create a man page?

i've never done this before. i created a script that I placed in /usr/bin, but want to create a man page for it. i'm clueless thanks (3 Replies)
Discussion started by: theDirtiest
3 Replies
Login or Register to Ask a Question