LinuxQuestions.org
Share your knowledge at the LQ Wiki.
Go Back   LinuxQuestions.org > Forums > Linux Forums > Linux - Distributions > Red Hat
User Name
Password
Red Hat This forum is for the discussion of Red Hat Linux.

Notices

Reply
 
Search this Thread
Old 01-17-2008, 01:18 AM   #1
minhstone
LQ Newbie
 
Registered: Jan 2008
Posts: 7

Rep: Reputation: 0
I can't change manual page ... Help me !


hi all,
I want to add help document into manual page but i don't want ask "man ./"command". When i ask : # man ./"command" then OK. But i ask : # man "command" then have problem display :"No maual entry for "command"".


Who can help me ... step ..step.. change manual page with some example.

Thank all.
 
Old 01-17-2008, 02:20 AM   #2
Disillusionist
Senior Member
 
Registered: Aug 2004
Location: England
Distribution: Ubuntu
Posts: 1,013

Rep: Reputation: 83
What are you trying to do?

Is this a new man page or are you modifying an existing one?

Have you already written the man page and formatted it to your satisfaction but just need to know were it should be placed?


Once the man page has been written, it should be gzipped and placed in the correct location.

If you have created a man page for my_command and you want to place it in section 1 of the man pages:

call the text file my_command.1
gzip my_command.1
[as root]:
mv my_command.1.gz /usr/share/man/man1/.

The man page can then be referenced using:
man my_command

*** If you are changing a pre-existing manpage, make sure you have a verified backup! ***
 
Old 01-17-2008, 02:27 AM   #3
ehawk
Senior Member
 
Registered: Jul 2003
Posts: 1,257

Rep: Reputation: 48
You can read through this:

http://tldp.org/HOWTO/Man-Page/index.html

Which is informative and step-by-step, but long....look especially at chapter 2 and the manpath command to figure out where the man page information is stored.

I also found this package:

http://wolfpack.twu.net/ManEdit/

Which may simplify things for you. I am not sure how up-to-date it is...if you are using a debian-based distribution, you may be able to install it easily using synaptic, if it is still supported. I just looked...it was last updated Feb. 2007, so it is pretty up to date..

Last edited by ehawk; 01-17-2008 at 02:30 AM.
 
Old 01-18-2008, 12:56 AM   #4
minhstone
LQ Newbie
 
Registered: Jan 2008
Posts: 7

Original Poster
Rep: Reputation: 0
thank you very much !

Quote:
Originally Posted by Disillusionist View Post
What are you trying to do?

Is this a new man page or are you modifying an existing one?

Have you already written the man page and formatted it to your satisfaction but just need to know were it should be placed?


Once the man page has been written, it should be gzipped and placed in the correct location.

If you have created a man page for my_command and you want to place it in section 1 of the man pages:

call the text file my_command.1
gzip my_command.1
[as root]:
mv my_command.1.gz /usr/share/man/man1/.

The man page can then be referenced using:
man my_command

*** If you are changing a pre-existing manpage, make sure you have a verified backup! ***

Thank you very much.
but if i don't want mv file to /usr/share/man/man1, i want to add directory path in man.config file then how do ...
you can instruct me step to step ?
thanks.
 
Old 01-18-2008, 01:41 AM   #5
Disillusionist
Senior Member
 
Registered: Aug 2004
Location: England
Distribution: Ubuntu
Posts: 1,013

Rep: Reputation: 83
If you have a folder /test that you want to contain your man pages, add the following entry to the /etc/manpath.config file

Code:
MANPATH   /test
However, this will only find your man pages if they are stored in subfolders to denote which section of the manual they belong to.

Therefore your manpage would need to be placed in: /test/man1 for section 1 /test/man2 for section 2
 
  


Reply


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 Off
HTML code is Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Using the sources.list(5) manual page Greebstreebling Debian 2 04-09-2007 10:07 AM
Refer to the mount.cifs(8) manual page bnebradd Linux - Networking 11 04-07-2007 03:40 AM
I cant change the default test page in apache server to add my page.y nhemapriya Linux - Newbie 3 05-13-2004 12:35 PM
Xman Error: no manual page found A-dummy Linux - General 3 01-13-2003 09:58 AM
see specific manual page herambshembekar Linux - Newbie 2 04-14-2002 12:33 PM


All times are GMT -5. The time now is 12:30 PM.

Main Menu
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