Manual - Revision history

Pbug: /* Searching in a man page */ the funny n (next) key.

2012-09-26T09:20:42Z

Searching in a man page: the funny n (next) key.

← Older revision		Revision as of 02:20, 26 September 2012
Line 97:		Line 97:
	/		/

	which is to "find another instance".		which is to "find another instance". This btw can also be achieved by typing "n" (lowercase) to search forward and "N" (uppercase) to search backwards, at least on [[FreeBSD]].

Franks at 03:44, 26 October 2007

2007-10-26T03:44:07Z

← Older revision		Revision as of 20:44, 25 October 2007
Line 1:		Line 1:
	~~Simple example to type at your [[shell]] prompt of most [[UBO]]s:~~		== About ==
	~~$ man 1 intro~~
	~~This brings up the man page for intro(1). You can use your spacebar to go down a page, and "q" for quit.~~


	Most ~~UNIX systems~~ have ~~online~~ manual pages.		Most [[UBO]]s have manual pages.

	MAN(1) OpenBSD Reference Manual MAN(1)		MAN(1) OpenBSD Reference Manual MAN(1)
Line 15:		Line 13:
	man -k keyword		man -k keyword
	DESCRIPTION		DESCRIPTION


	The types of manpages have sections which they are grouped in. Here is the manual page layout of [[BSD]]:		The types of manpages have sections which they are grouped in. Here is the manual page layout of [[BSD]]:


	;Section 1 : General commands (tools and utilities)		;Section 1 : General commands (tools and utilities)
Line 29:		Line 25:
	; Section 8 : System maintenance and operation commands		; Section 8 : System maintenance and operation commands
	; Section 9 : Kernel internals		; Section 9 : Kernel internals


	When someone tells you to run "man 6 tetris", that means that you should read the tetris manpage found in section 6 of the manpages. Sometimes the same manpage name exists, but in different sections. One example is the fstat manpage it exists in sections 1 and 2. The lower number sections take precedence over higher numbered sections. Thus, to see the manpage for fstat in section 2 you would type:		When someone tells you to run "man 6 tetris", that means that you should read the tetris manpage found in section 6 of the manpages. Sometimes the same manpage name exists, but in different sections. One example is the fstat manpage it exists in sections 1 and 2. The lower number sections take precedence over higher numbered sections. Thus, to see the manpage for fstat in section 2 you would type:
Line 36:		Line 31:
	Similarely functions, [[syscall]]s or commands are sometimes mentioned with the section of manpages in brackets behind them like so: '''fstat(2)''', you'll see this mentioned a lot in this wiki.		Similarely functions, [[syscall]]s or commands are sometimes mentioned with the section of manpages in brackets behind them like so: '''fstat(2)''', you'll see this mentioned a lot in this wiki.

			Simple example to type at your [[shell]] prompt of most [[UBO]]s:
			$ man 1 intro
			This brings up the man page for intro(1). You can use your spacebar to go down a page, and "q" for quit.

			== Installing manpages ==

			On [[Debian]] based GNU/[[Linux]]:

			$ sudo apt-get install manpages

	=== Creating windex ===		== Creating windex ==

	If you're looking for a man page and get the following:		If you're looking for a man page and get the following:
Line 47:		Line 51:
	#		#

	=== Searching for Manual Pages ===		== Searching for Manual Pages ==

	It is possible to do a keyword search in the manpage system.		It is possible to do a keyword search in the manpage system.
Line 66:		Line 70:
	<code>$MANPATH</code> is used, unless something else is explicitly specified.		<code>$MANPATH</code> is used, unless something else is explicitly specified.

	=== Location of Manual Pages ===		== Location of Manual Pages ==

	In [[BSD]] the default manual pages are located in /usr/share/man. This can be changed with the MANPATH [[environment variable]]:		In [[BSD]] the default manual pages are located in /usr/share/man. This can be changed with the MANPATH [[environment variable]]:

Franks at 03:38, 26 October 2007

2007-10-26T03:38:55Z

← Older revision		Revision as of 20:38, 25 October 2007
Line 1:		Line 1:
	Simple example to type at your [[shell]] prompt:		Simple example to type at your [[shell]] prompt of most [[UBO]]s:
	$ man 1 intro		$ man 1 intro
	This brings up the man page for intro(1). You can use your spacebar to go down a page, and "q" for quit.		This brings up the man page for intro(1). You can use your spacebar to go down a page, and "q" for quit.

Hawson: Reverted edits by Mr8M9x (Talk); changed back to last version by Franks

2007-09-21T13:33:30Z

Reverted edits by Mr8M9x (Talk); changed back to last version by Franks

← Older revision		Revision as of 06:33, 21 September 2007
Line 75:		Line 75:
	$ unset MANPATH		$ unset MANPATH
	$ man ls		$ man ls
	LS(1)		LS(1) OpenBSD Reference Manual LS(1)
	~~1000~~
	OpenBSD Reference Manual LS(1)
	...		...

Mr8M9x at 22:27, 19 September 2007

2007-09-19T22:27:22Z

← Older revision		Revision as of 15:27, 19 September 2007
Line 75:		Line 75:
	$ unset MANPATH		$ unset MANPATH
	$ man ls		$ man ls
	LS(1) OpenBSD Reference Manual LS(1)		LS(1)
			1000
			OpenBSD Reference Manual LS(1)
	...		...

Franks at 00:15, 3 March 2006

2006-03-03T00:15:52Z

← Older revision		Revision as of 17:15, 2 March 2006
Line 1:		Line 1:
			Simple example to type at your [[shell]] prompt:
			$ man 1 intro
			This brings up the man page for intro(1). You can use your spacebar to go down a page, and "q" for quit.


	Most UNIX systems have online manual pages.		Most UNIX systems have online manual pages.

Frankk: /* Creating windex */

2005-11-07T01:13:34Z

Creating windex

← Older revision		Revision as of 18:13, 6 November 2005
Line 39:		Line 39:

	It means you have yet to create your Index:		It means you have yet to create your Index:
	# /usr/bin/catman -w		# [[variables\|/usr/bin/catman]] -w
	#		#

Pbug: align the sections right

2005-11-03T11:28:25Z

align the sections right

← Older revision		Revision as of 04:28, 3 November 2005
Line 32:		Line 32:


	== Creating windex ==		=== Creating windex ===

	If you're looking for a man page and get the following:		If you're looking for a man page and get the following:

Pbug: /* Searching for Manual Pages */ remove mention of building windex since it was added as its own section earlier

2005-11-03T11:26:57Z

Searching for Manual Pages: remove mention of building windex since it was added as its own section earlier

← Older revision		Revision as of 04:26, 3 November 2005
Line 57:		Line 57:
	tar (1) - tape archiver		tar (1) - tape archiver

	Do notice that the section of the manpage is displayed in the keyword search, this is to ease viewing the particular manpage. ~~Do note that when you are on Solaris you may have to build the manual page index in order to search for keywords. This is done with the catman command:~~		Do notice that the section of the manpage is displayed in the keyword search, this is to ease viewing the particular manpage.

	~~$ catman -w~~

	<code>$MANPATH</code> is used, unless something else is explicitly specified.		<code>$MANPATH</code> is used, unless something else is explicitly specified.

Frankk at 02:08, 3 November 2005

2005-11-03T02:08:31Z

← Older revision		Revision as of 19:08, 2 November 2005
Line 32:		Line 32:


			== Creating windex ==

			If you're looking for a man page and get the following:
			# man -k snoop
			/usr/share/man/windex: No such file or directory

			It means you have yet to create your Index:
			# /usr/bin/catman -w
			#

	=== Searching for Manual Pages ===		=== Searching for Manual Pages ===