MMMMAAAANNNN((((1111))))									MMMMAAAANNNN((((1111))))



NNNNAAAAMMMMEEEE
     man - print entries from the on-line reference manuals; find manual
     entries by	keyword

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     mmmmaaaannnn [----ccccddddwwwwWWWWttttpppprrrr] [----MMMM	_p_a_t_h] [----TTTT _m_a_c_r_o_p_a_c_k_a_g_e]	[_s_e_c_t_i_o_n] _t_i_t_l_e	...
     mmmmaaaannnn [----MMMM _p_a_t_h] ----kkkk _k_e_y_w_o_r_d ...
     mmmmaaaannnn [----MMMM _p_a_t_h] ----ffff _f_i_l_e_n_a_m_e ...

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     _m_a_n locates and prints the	_t_i_t_l_eed	entries	from the on-line reference
     manuals.  _m_a_n also	prints summaries of manual entries selected by _k_e_y_w_o_r_d
     or	by associated _f_i_l_e_n_a_m_e.

     If	a _s_e_c_t_i_o_n is given, only that particular section is searched for the
     specified _t_i_t_l_e.  The current list	of valid sections are any single digit
     [0-9], the	letter 'D', plus the sections llllooooccccaaaallll, ppppuuuubbbblllliiiicccc, nnnneeeewwww, and oooolllldddd,
     corresponding to the sections llll, pppp, nnnn, and	oooo, respectively.  When a
     section name of this form is given, the first character is	used to	form
     the directory, thus "local", will cause directories ending	in "manl" to
     be	searched.  To find a man page with the name of one of these sections,
     it	is necessary to	first give a dummy name, such as "man junk local",
     which is unfortunate.

     If	no _s_e_c_t_i_o_n is given, all sections of the on-line reference manuals are
     searched and all occurrences of _t_i_t_l_e are printed.	 The default sections
     are searched in this order:  1111nnnnllll6666888822223333444455557777ppppooooDDDD

     Manual entries are	retrieved in the following order:  for each root
     directory in the search path, language specific directories are searched
     first (see	discussion of the LLLLAAAANNNNGGGG environment variable below), followed
     by	generic	directories. Within each of those searches, local additions
     are searched first, followed by the standard manual directories.  In each
     leaf directory, there may be actual pages or subdirectories.  If the
     subdirectory name has the format _c_a_t[_1-_8_l_n_o_p_D] then the pages in that
     subdirectory are treated as pre-formatted "cat" manual entries.  If the
     subdirectory name has the format _m_a_n[_1-_8_l_n_o_p_D] then the pages in that
     subdirectory are treated as unformatted _n_r_o_f_f(1) source manual entries.
     Unformatted manual	entries	will be	processed by _n_e_q_n(1), _t_b_l(1),
     _n_r_o_f_f(1), and _c_o_l(1).  (See the CCCCAAAAVVVVEEEEAAAATTTTSSSS section concerning	formatting
     unformatted manual	pages.)	 These must be installed with a	standard
     suffix, such as ._1_m, in order for the _m_a_n command to find them (i.e.,
     name, period, suffix).  The "cat" manual entries are compressed to	save
     disk space	using _p_a_c_k(1), _c_o_m_p_r_e_s_s(1), or _g_z_i_p(1);	all pre-formatted man
     pages must	be compressed with one of the abvoe in order for the man
     command to	find them.  _m_a_n	will automatically uncompress compressed "cat"
     manual entries using _p_c_a_t(1), _z_c_a_t(1), or _g_z_c_a_t(1)	respectively.

     After the local additions are searched, the standard pre-formatted	manual
     entries in	/_u_s_r/_s_h_a_r_e/_c_a_t_m_a_n/[_a_g_p_u]__m_a_n are searched.





									PPPPaaaaggggeeee 1111






MMMMAAAANNNN((((1111))))									MMMMAAAANNNN((((1111))))



     After searching /_u_s_r/_s_h_a_r_e/_c_a_t_m_a_n,	_m_a_n will search	/_u_s_r/_s_h_a_r_e/_m_a_n ,
     /_u_s_r/_c_a_t_m_a_n , then	/_u_s_r/_m_a_n , for manual pages.  The user may override
     these default root	directories for	manual entries with the	environment
     variable MMMMAAAANNNNPPPPAAAATTTTHHHH or with the command-line options ----MMMM and ----dddd.  (See
     discussion	below.)

     IIIIRRRRIIIIXXXX is derived from four main sources: AT&T, Berkeley, MIPS Computer
     Systems, and Sun Microsystems.  Because development at these sources is
     more or less independent, in several cases	programs have been given the
     same name but have	vastly different functionality.	 The manual entries
     for such programs have been distinguished by giving them suffixes:	 ____aaaatttttttt,
     ____bbbbssssdddd, ____mmmmiiiippppssss, or ____ssssuuuunnnn.  You	do not need to give the	suffixes.  If _m_a_n is
     given an un-suffixed title	_t_i_t_l_e for which	suffixed entries exist,	it
     will display all of them.

     Searches for _t_i_t_l_e_s, _k_e_y_w_o_r_d_s, and	_f_i_l_e_n_a_m_e_s are case-insensitive.	 For
     example, the manual entry _R_G_B_c_o_l_o_r(3G) can	be gotten by the command-line:

	  man rgbcolor

     Also, _t_i_t_l_e_s, _k_e_y_w_o_r_d_s, and _f_i_l_e_n_a_m_e_s may contain special characters
     allowing manual pages to looked up	by only	specifying partial names in
     much the same way that _s_h(1) and _c_s_h(1) match file	names.	For example,
     the summaries of manual entries pertaining	to RGB writemasks may be
     searched by the command-line:

	  man -k 'rgb*mask'

     The complete set of special characters is as follows:


     ****	    Match any sequence of characters, including	none-at-all.

     ????	    Match any single character.

     [[[[............]]]]  Matches any	of the set of characters between the brackets.	A pair
	    of characters separated by ---- matches any one of the	characters
	    which comes	between	the two	characters, including the two
	    characters,	based on ASCII character encoding (see _a_s_c_i_i(5)).


     _m_a_n also supports a more sophisticated means for looking up manual	pages
     using regular expressions.	 To use	regular	expressions to lookup manual
     pages, you	must use the ----rrrr	option discussed below.

OOOOPPPPTTTTIIIIOOOONNNNSSSS
     ----MMMM	_p_a_t_h	  Use _p_a_t_h as the search path for manual entries.  _p_a_t_h	is a
		  colon-separated list of directories where manual
		  subdirectories may be	found.	The default path is
		  /_u_s_r/_s_h_a_r_e/_c_a_t_m_a_n:/_u_s_r/_s_h_a_r_e/_m_a_n:/_u_s_r/_c_a_t_m_a_n:/_u_s_r/_m_a_n.  ----MMMM
		  is useful for	searching locations other than the standard
		  manual directories for manual	entries.  These	locations



									PPPPaaaaggggeeee 2222






MMMMAAAANNNN((((1111))))									MMMMAAAANNNN((((1111))))



		  could	be personal manual page	trees or NFS mounted BSD style
		  manual page trees from another system.  For example, the
		  standard manual directories could be augmented with personal
		  manual pages by specifying the path:

		    /usr/share/catman:/usr/share/man:/usr/catman:/usr/man:$HOME/man

		  ----MMMM must be given before ----kkkk and ----ffff.  ----MMMM will override the
		  environment variable MMMMAAAANNNNPPPPAAAATTTTHHHH.	 ----MMMM and	----dddd are mutually
		  exclusive.  At most 100 directories may be specified;	if
		  more are specified, the rest will be ignored.

     ----cccc		  Copy the manual page to the standard output instead of using
		  _m_o_r_e(1) or the user specified	PPPPAAAAGGGGEEEERRRR or MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR.

     ----dddd		  Use the direct path specified	for finding the	manual page
		  _t_i_t_l_e.  The ----dddd option	uses the full path name	of the
		  specified _t_i_t_l_e as the manual	page to	print, formatting it
		  if necessary.	 Since ----dddd does no searching, any suffixes like
		  ".1" must be specified otherwise the manual page will	not be
		  found.  If no	leading	path is	specified, the current
		  directory (.)	is assumed.  ----dddd	is useful for formatting
		  manual page sources you are editing as part of your software
		  development.	The ----tttt option may be used in conjunction with
		  ----dddd to	format a manual	page source file and send it to	the
		  printer.  ----dddd will ignore the environment variable MMMMAAAANNNNPPPPAAAATTTTHHHH.
		  ----dddd and ----MMMM are	mutually exclusive.

     ----pppp		  Print	on standard output the commands	that would be executed
		  to format and	display	the specified manual pages instead of
		  actually executing the commands.  The	printed	command
		  reflects the environment variable settings described below.

     ----wwww		  Print	only the _p_a_t_h_n_a_m_e of each entry	matching the given
		  _t_i_t_l_e.  The actual matching entry will not be	printed, only
		  its path is given.

     ----tttt		  Typeset each _t_i_t_l_ed manual entry and send the	result to the
		  printer.  In the case	of the preformatted "cat" manual pages
		  which	come standard with IIIIRRRRIIIIXXXX, the entry is unpacked using
		  _p_c_a_t(1) and then sent	to the default printer using _l_p(1).
		  If, however, the manual entry	is a locally added,
		  unformatted _n_r_o_f_f(1) source, the entry will be formatted
		  using	_p_s_r_o_f_f(1) and sent to the printer.  The	environment
		  variable TTTTRRRROOOOFFFFFFFF may be	used to	specify	another	formatting
		  program other	than _p_s_r_o_f_f (see the discussion	on EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
		  below.  If the BSD _l_p_r(1) printing facility is used, the
		  TTTTCCCCAAAATTTT and NNNNCCCCAAAATTTT	environment variables should be	set to send
		  the output to	_l_p_r instead of _l_p.






									PPPPaaaaggggeeee 3333






MMMMAAAANNNN((((1111))))									MMMMAAAANNNN((((1111))))



     ----TTTT	_m_a_c_r_o_p_a_c_k_a_g_e
		  The given _n_r_o_f_f(1) macro package will	be used	for formatting
		  unformatted manual entries.  By default,
		  /_u_s_r/_l_i_b/_t_m_a_c/_t_m_a_c._a_n	is used.

     ----kkkk	_k_e_y_w_o_r_d	  Print	the manual entry summaries which contain the given
		  _k_e_y_w_o_r_ds.  The summaries are gotten from the _w_h_a_t_i_s
		  database.  (See also _a_p_r_o_p_o_s(1).)

     ----ffff	_f_i_l_e_n_a_m_e  Print	the manual entry summaries which might pertain to the
		  given	_f_i_l_e_n_a_m_es.  Any	leading	pathname components are
		  stripped from	the _f_i_l_e_n_a_m_e before the	_f_i_l_e_n_a_m_e is matched
		  against the summaries.  The summaries	are gotten from	the
		  _w_h_a_t_i_s database.  (See also _w_h_a_t_i_s(1).)

     ----WWWW		  is normally used only	by the _m_a_k_e_w_h_a_t_i_s(1m) command to build
		  the _w_h_a_t_i_s and _a_p_r_o_p_o_s databases.

     ----rrrr		  Treat	specified names	as regular expressions for searches.
		  The regular expressions handled are those supported by
		  _r_e_g_e_x(3X).

EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
     MMMMAAAANNNNPPPPAAAATTTTHHHH  If set, MMMMAAAANNNNPPPPAAAATTTTHHHH overrides	the default manual entry search	path.
	      MMMMAAAANNNNPPPPAAAATTTTHHHH is a colon-separated list	of directories where manual
	      subdirectories may be found.  (See the discussion	of ----MMMM.)	 ----MMMM
	      and ----dddd will override MMMMAAAANNNNPPPPAAAATTTTHHHH.

     LLLLAAAANNNNGGGG     If set, then for each directory to be searched (as determined by
	      the ----MMMM option, the MMMMAAAANNNNPPPPAAAATTTTHHHH variable, or the default search
	      path), an	additional directory is	constructed and	searched which
	      has the value of the LLLLCCCC____MMMMEEEESSSSSSSSAAAAGGGGEEEESSSS locale catagory appended	to it.
	      These language specific directories are searched before the
	      corresponding generic directory.	LLLLCCCC____MMMMEEEESSSSSSSSAAAAGGGGEEEESSSS may	be set either
	      in the environment or will automatically be set based on the
	      setting of the LLLLAAAANNNNGGGG variable (see	_eeee_nnnn_vvvv_iiii_rrrr_oooo_nnnn(5)).

     PPPPAAAAGGGGEEEERRRR and MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR
	      If set, PPPPAAAAGGGGEEEERRRR and	MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR specify a program for interactively
	      displaying the output from _m_a_n.  MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR	will override PPPPAAAAGGGGEEEERRRR so
	      a	program	other than the user's standard paging program may be
	      used for displaying _m_a_n output.  If neither PPPPAAAAGGGGEEEERRRR	or MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR
	      are set, the command "ul -b | more -s -f"	is used.  See _u_l(1)
	      and _m_o_r_e(1) for details on these options.

     MMMMAAAANNNNFFFFMMMMTTTTCCCCMMMMDDDD
	      may be used to specify the full command to format	unformatted
	      man pages.  If set, the other formatter environment variables
	      are ignored, as is the -_T	option.	 The command will be given a
	      single argument, which is	the full pathname of the man page that
	      is to be formatted.




									PPPPaaaaggggeeee 4444






MMMMAAAANNNN((((1111))))									MMMMAAAANNNN((((1111))))



     TTTTCCCCAAAATTTT     may be used to specify the command for printing or displaying
	      unformatted (nroff/troff source) manual pages when the ----tttt	option
	      is selected.  If TTTTCCCCAAAATTTT is not set,	the command "lp" is used.  For
	      systems using the	BSD _l_p_r(1) printing facility, TTTTCCCCAAAATTTT should be
	      set to "lpr".  If	a troff	formatting program which does not
	      output PostScript	is used, TTTTCCCCAAAATTTT should be	set to "lpr <option>"
	      where <option> specifies the proper printing for the troff
	      output.

     NNNNCCCCAAAATTTT     may be used to specify the command for printing or displaying
	      preformatted manual pages	when the ----tttt option is selected.	 If
	      NNNNCCCCAAAATTTT is not set, the command specified by	TTTTCCCCAAAATTTT is	used.  It is
	      only necessary to	set NNNNCCCCAAAATTTT if TTTTCCCCAAAATTTT is set	to "lpr	<option>"
	      where <option> specifies printing	of some	special	(non-ASCII)
	      format.

     TTTTRRRROOOOFFFFFFFF    may be used to specify a formatter to use	when the ----tttt option is
	      selected,	and unformatted	man pages are processed.  The command
	      specified	by TTTTRRRROOOOFFFFFFFF must output its results to the	standard
	      output for TTTTCCCCAAAATTTT to work.	If TTTTRRRROOOOFFFFFFFF is not	set, the command
	      "psroff -t" is used.

     NNNNRRRROOOOFFFFFFFF    Similar to TTTTRRRROOOOFFFFFFFF above, used when	the ----tttt option is not
	      specified.

FFFFIIIILLLLEEEESSSS
     /usr/share/catman			 root directory	of on-line reference
					 manual	entry tree
     /usr/share/catman/whatis		 table of contents and keyword
					 database
     /usr/share/catman/u_man/cat[1,6]/*	 user manual pages
     /usr/share/catman/a_man/cat[1,4,7]/*
					 system	administrator manual pages
     /usr/share/catman/p_man/cat[2-5]/*	 programmer manual pages
     /usr/share/catman/g_man/cat3/*	 Graphics Library manual pages
     /usr/share/catman/local/cat[1-8lnop]/*
					 local pre-formatted manual entries
     /usr/catman/local/man[1-8lnop]/*	 local unformatted _n_r_o_f_f(1) source
					 manual	entries
     /usr/share/man/*			 additional unformatted	manual pages
     /usr/lib/tmac/tmac.an		 default macro package used for
					 formatting manual entries (contained
					 in the	_D_o_c_u_m_e_n_t_o_r'_s _W_o_r_k _B_e_n_c_h
					 software option)

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     apropos(1), col(1), compress(1), csh(1), eqn(1), grep(1), gzip(1),	lp(1),
     lpr(1), makewhatis(1M), more(1), neqn(1), nroff(1), pack(1), pcat(1),
     psroff(1),	sh(1), tbl(1), troff(1), ul(1),	whatis(1), zcat(1), regex(3X),
     ascii(5), environ(5), man(5), term(5).





									PPPPaaaaggggeeee 5555






MMMMAAAANNNN((((1111))))									MMMMAAAANNNN((((1111))))



CCCCAAAAVVVVEEEEAAAATTTTSSSS
     _a_p_r_o_p_o_s (_m_a_n -_k) and _w_h_a_t_i_s (_m_a_n -_f) require that the _w_h_a_t_i_s database be
     kept up to	date by	running	_m_a_k_e_w_h_a_t_i_s(1M) after installing	or removing
     software from the system.	This command is	run by default on system
     reboot when software is installed or removed by the _i_n_s_t(1m) command.  If
     the _w_h_a_t_i_s	database is not	kept up	to date, _a_p_r_o_p_o_s (_m_a_n -_k) and _w_h_a_t_i_s
     (_m_a_n -_f) will not find entries for	new manual pages and will erroneously
     refer to manual pages which no longer exist on the	system.

     The /_u_s_r/_s_h_a_r_e/_c_a_t_m_a_n directories have all	been processed by _n_r_o_f_f(1).
     AT&T does not allow Silicon Graphics, Inc.	to ship	the _n_r_o_f_f(1) sources
     for manual	pages.

     To	format locally added, unformatted manual pages,	_m_a_n requires _n_r_o_f_f(1),
     _t_b_l(1), and _n_e_q_n(1) or _e_q_n(1) and _p_s_r_o_f_f(1) with the ----tttt option; these are
     contained in the _D_o_c_u_m_e_n_t_o_r'_s _W_o_r_k	_B_e_n_c_h software option, except
     _p_s_r_o_f_f(1),	which is part of the _I_m_p_r_e_s_s_a_r_i_o product.  If they are not
     found in the search path, a message to this effect	will be	printed	once
     per invocation of _m_a_n.  The _a_w_f(1)	command	is then	searched for, and if
     found, it will be used instead.  It does not understand all the
     formatting	commands, but is usually good enough (the -_T option is ignored
     in	this case).  If	_a_w_f isn't found	either,	then any unformatted man pages
     will be skipped.

     _p_s_r_o_f_f and	_n_r_o_f_f may be overridden	with environment variables (see
     above), but the others may	not; they must exist somewhere in the search
     path, unless the MMMMAAAANNNNFFFFMMMMTTTTCCCCMMMMDDDD	variable is set.  If none of these can be
     used, it may be possible to format	the man	pages on a system that does
     have the formatting commands available.  The resulting formatted versions
     may be installed on IRISes	which do not have the _D_o_c_u_m_e_n_t_o_r'_s _W_o_r_k	_B_e_n_c_h.
     To	create pre-formatted manual pages, use the commands:


	  neqn mymanpage.1 | tbl | nroff -man >	mymanpage
	  pack -f mymanpage

     The resulting _m_y_m_a_n_p_a_g_e._z file may	be copied into the appropriate
     /_u_s_r/_l_o_c_a_l/_m_a_n/_c_a_t[_1-_8] directory.

     _m_a_n will not locate manual	pages in directories with names	containing a
     period (.).

     _m_a_n may produce some extra	matches	if man page names have a period	(.) in
     them, as it matches up to a period, assuming the rest is a	suffix.











									PPPPaaaaggggeeee 6666