Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
catman(1M)							    catman(1M)

NAME
       catman -	create the cat files for the manual

SYNOPSIS
       alt-path] [sections]

DESCRIPTION
       The  command  creates  the formatted versions of	the online manual from
       nroff(1)-compatible source files.  Each manual entry in the and	direc-
       tories  is  examined, and those whose formatted versions	are missing or
       out-of-date are recreated.  formats the most  recent  of	 the  entries,
       compresses it, and puts it into the appropriate directory.

       If any changes are made,	recreates the database.	 By default, the data-
       base is overwritten.  If	the environment	variable is set	to  a  non-de-
       fault  set  of paths, the old database file is saved in so that,	if de-
       sired, the system administrator may merge them together.

       By default, searches the	and subdirectories under the following man di-
       rectories:
	      o
	      o
	      o
       If  is set in the environment, the directories given in are checked in-
       stead of	the default.  See environ(5) for a description of the environ-
       ment variable.

       Before running remove any existing directories.	If the option is used,
       directories should be removed instead.  If both and directories	exist,
       man(1) updates both directories and more	space is used.

       Any command-line	parameters not starting	with are interpreted as	a list
       of manual sections (directories)	to search.  For	example:

       restricts updating to manual sections 1,	2, and 3 (directories and

   Options
       supports	the following options:

	      Create a merged
			     database; i.e., information on new	manual entries
			     (added  since  the	 last  time was	run) is	merged
			     into the current database rather than overwriting
			     it.  Ignored if selected with the option.

	      Prevents creation	of

	      Prints what would	be done	instead	of doing it.

	      Causes only the
			     database  to  be created.	No manual reformatting
			     is	done.

	      Puts the formatted entries in the
			     directories rather	than in	the directories.

	      Perform actions based on the given alternate root.
			     With this option, alt-path	will be	 prepended  to
			     all directory paths, including default paths, the
			     paths defined by and the path to

EXTERNAL INFLUENCES
   Environment Variables
       defines parent directories to be	used when searching and	directories.

WARNINGS
       If unformatted manual entries (those in the subdirectories)  have  been
       removed since the last time was run, information	in the database	may be
       lost.  The option may be	used to	override this, but may result  in  re-
       peated lines in the database for	the same manual	entry.

EXAMPLES
       Create  uncompressed  files  for	 sections  1 and 1m of the manual, but
       don't create the	database:

       Run from	a server to create entries for a diskless client under the al-
       ternate root

       This will create	manpages under:

       and a file in:

       Create  entries	for  an	application and	merge the information with the
       database:

       Note that you may wish to save before doing this, so  as	 not  to  lose
       your current

AUTHOR
       was developed by	HP and the University of California, Berkeley.

FILES
       Unformatted  (nroff(1)-compatible  source)  manual  entry  files	 [com-
       pressed].
       Formatted manual	pages [compressed].
       Database	of manpage entry summaries; utilized by	the
	      command.
       Command to make
	      database.

SEE ALSO
       compress(1), fixman(1M),	man(1),	environ(5).

								    catman(1M)

NAME | SYNOPSIS | DESCRIPTION | EXTERNAL INFLUENCES | WARNINGS | EXAMPLES | AUTHOR | FILES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=catman&sektion=1m&manpath=HP-UX+11.22>

home | help