elks-enhanced - XT-Emporium

File editor

.TH man 1
.SH NAME
man \- display on-line reference manuals
.SH SYNOPSIS
.B man
[\fB\-w\fR] [\fB\-b\fR|\fB\-q\fR]
.I [section-number] page ...
.SH DESCRIPTION
This document describes the ELKS version of
.BR man .
This version is extremely minimal and should not be used whenever using a
better version is practical.
.B man
is the system's manual pager. Each
.I page
argument given is the name of a program, file, function system call or other
system feature which should be documented in the systems manual.
.B man
will try and locate and display a manual page for each
.I page
operand given. If a numeric
.I section
operand is given, then
.B man
will only look in that section of the manual, rather than all the sections
which is the default.
.PP
Here is a list of the manual sections:-
.PP
1 Program or shell commands
.br
2 System calls in the kernel
.br
3 Functions in the libraries
.br
4 Special device files
.br
5 File formats
.br
6 Games
.br
7 Macro packages
.br
8 System administration programs
.br
9 Kernel routines
.PP
Unlike other man program, this one does not use an external formatter such
as nroff, as we currently do not have one. It supports a subset of nroff
-man features which are sufficient for displaying ELKS manual pages.
.SS OPTIONS
.TP
.B "-w"
Do not display any manual pages, but print the location of each one found.
.TP
.B "-v"
Force verbose output. (default)
.TP
.B "-q"
Force quiet output.
.SH EXAMPLES
.IP
.B man ls
# Display the manual page for ls
.IP
.B man -w cp
# Display the location of man page for cp
.SH ENVIRONMENT
.B man
obeys the following environment variables.
.TP
.SB MANSECT
A colon separated list of single digit section numbers indicating the sections
to be searched, and the search order.
.TP
.SB MANPATH
A colon separated list of directories to search for a manual page tree.
.TP
.SB PAGER
The name of the program to be used to display the manual page.
.TP
.SB PATH
A colon separated list of directories to search for commands including the
program specified by PAGER, and gzip and compress used to uncompress compressed
manual pages.
.SH EXIT STATUS
.TP
.I 0
Completed successfully.
.TP
.I 1
No
.I page
specified on no manual page found.
.SH FILES
.PD 0
.TP
.B /lib/man?/*
.PD
.SH BUGS
Plenty I am sure.
.SH AUTHORS
Rob de Bath
.br
Al Riddoch (ajr@ecs.soton.ac.uk) (this manpage)
.SH SEE ALSO
.BR more (1),
.BR compress (1),
.BR cat (1).
Commit message
This repository is read-only for this account.
Repository snapshot

Current branch
master
Visibility
public
Your access
Read
Remote
Configured
File activity

View file history