man.1

   1 .TH man 1 "Sept 2013" "hardcore-utils" \" -*- nroff -*-
   2 .SH NAME
   3 man \- display on-line reference manuals
   4 .SH SYNOPSIS
   5 .B man
   6 [\-w] [\-v|\-q] [section-number] page ...
   7 .SH DESCRIPTION
   8 This document describes
   9 .BR man .
  10 .B man
  11 is the system's manual pager. Each
  12 .I page
  13 argument given is the name of a program, file, function system call or other
  14 system feature which should be documented in the systems manual.
  15 .B man
  16 will try and locate and display a manual page for each
  17 .I page
  18 operand given. If a numeric
  19 .I section
  20 operand is given, then
  21 .B man
  22 will only look in that section of the manual, rather than all the sections
  23 which is the default.
  24 .PP
  25 Here is a list of the manual sections:-
  26 .PP
  27 1 Program or shell commands
  28 .br
  29 2 System calls in the kernel
  30 .br
  31 3 Functions in a the libraries
  32 .br
  33 4 Special device files
  34 .br
  35 5 File formats
  36 .br
  37 6 Games
  38 .br
  39 7 Macro packages
  40 .br
  41 8 System administration programs
  42 .br
  43 9 Kernel routines
  44 .PP
  45 Unlike other man program, this one does not use an external formatter such
  46 as nroff, as we currently do not have one. It supports a subset of nroff
  47 -man features which are sufficient for displaying ELKS manual pages.
  48 .SS OPTIONS
  49 .TP
  50 .I "-w"
  51 Do not display any manual pages, but print the location of each one found.
  52 .TP
  53 .I "-v"
  54 Force verbose output. (default)
  55 .TP
  56 .I "-q"
  57 Force quiet output.
  58 .SH EXAMPLES
  59 .IP
  60 man ls
  61 .IP
  62 man -w cp
  63 .LP
  64 Display the manual page for ls, and the location of the manual page for cp
  65 respectively.
  66 .SH ENVIRONMENT
  67 .B man
  68 obeys the following environment variables.
  69 .TP
  70 .SB MANSECT
  71 A colon separated list of single digit section numbers indicating the sections
  72 to be searched, and the search order.
  73 .TP
  74 .SB MANPATH
  75 A colon separated list of directories to search for a manual page tree.
  76 .TP
  77 .SB PAGER
  78 The name of the program to be used to display the manual page.
  79 .TP
  80 .SB PATH
  81 A colon separated list of directories to search for commands including the
  82 program specified by PAGER, and gzip and compress used to uncompress compressed
  83 munual pages.
  84 .SH EXIT STATUS
  85 .TP
  86 .B 0
  87 Completed successfully.
  88 .TP
  89 .B 1
  90 No
  91 .I page
  92 specified on no manual page found.
  93 .SH FILES
  94 .PD 0
  95 .TP
  96 .B /usr/share/man?/*
  97 .PD
  98 .SH BUGS
  99 Plenty I am sure.
 100 .SH AUTHORS
 101 Rob de Bath
 102 .br
 103 Al Riddoch (ajr@ecs.soton.ac.uk) (this manpage)
 104 .SH SEE ALSO
 105 .BR more (1),
 106 .BR cat (1).