man.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Sat, 26 Dec 2009 13:06:11 +0200
changeset 261 0332d38237db
parent 111 3bd7637e1f68
child 293 69ddc7efeb14
permissions -rw-r--r--
Rename ssh article to remote-shell.

-*- outline -*-

* Man sections.

  1 Executable programs or shell commands.
  2 System calls (functions provided by the kernel).
  3 Library calls (functions within program libraries).
  4 Special files (usually found in /dev).
  5 File formats and conventions eg /etc/passwd.
  6 Games.
  7 Miscellaneous (including macro  packages  and  conventions).
  8 System administration commands (usually only for root).

* Invoking man.

** Search for prog, func, conf file.

  $ man [<section>] <item>

** Search by specific keywords.

  $ man -k <keywords>

** Throw Emacs.

  M-x man RET [<section>] <item>

  M-x man RET -k SPACE <keywords>

* Sections order.

NAME                - brief prog description
SYNOPSIS (USAGE)    - command line options in BNF
DESCRIPTION         - long prog description
OPTIONS             - long option descriptions
... misc sections ...
EXAMPLES
EXIT STATUS
ENVIRONMENT
AVAILABILITY        - whare search source, where home page
FILES               - list of files that has effect on program working
AUTHORS
COPYRIGHT
SEE ALSO
BUGS                - know issue, how report bug
HISTORY