2020-11-24 10:37:36 +11:00
|
|
|
\chapter{manpages}
|
2020-11-28 00:44:53 +11:00
|
|
|
\index{man}
|
|
|
|
|
\label{chap:manpages}
|
2020-11-24 10:37:36 +11:00
|
|
|
|
2024-09-30 08:57:24 +11:00
|
|
|
Guidelines for writing man pages can be found in \texttt{mdoc(7)}.
|
2020-12-23 08:53:57 +11:00
|
|
|
|
2024-09-30 08:57:24 +11:00
|
|
|
\texttt{man} is the system's manual pager. Each page argument given to man is
|
2020-12-23 08:53:57 +11:00
|
|
|
normally the name of a program, utility or function. The manual page
|
|
|
|
|
associated with each of these arguments is then found and displayed. A
|
|
|
|
|
section, if provided, will direct man to look only in that section of
|
|
|
|
|
the manual. The default action is to search in all of the available
|
|
|
|
|
sections following a pre-defined order ("1 n l 8 3 2 3posix 3pm 3perl
|
|
|
|
|
3am 5 4 9 6 7" by default, unless overridden by the SECTION directive
|
|
|
|
|
in /etc/manpath.config), and to show only the first page found, even if
|
|
|
|
|
page exists in several sections.
|
2020-11-24 10:37:36 +11:00
|
|
|
|
|
|
|
|
|
|
|
|
|
\section{Un exemple ?}
|
|
|
|
|
|
|
|
|
|
XXX\index{XXX}
|
|
|
|
|
|
2020-12-23 08:53:57 +11:00
|
|
|
Voir \texttt{roff}\index{roff} en page \pageref{roff}.
|
