man.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Wed, 27 Jan 2010 21:16:24 +0200
changeset 289 2f51e10a0b6a
parent 111 3bd7637e1f68
child 293 69ddc7efeb14
permissions -rw-r--r--
Added links.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
14
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     1
-*- outline -*-
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
111
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
     3
* Man sections.
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
     4
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
     5
  1 Executable programs or shell commands.
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
     6
  2 System calls (functions provided by the kernel).
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
     7
  3 Library calls (functions within program libraries).
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
     8
  4 Special files (usually found in /dev).
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
     9
  5 File formats and conventions eg /etc/passwd.
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    10
  6 Games.
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    11
  7 Miscellaneous (including macro  packages  and  conventions).
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    12
  8 System administration commands (usually only for root).
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    13
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    14
* Invoking man.
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    15
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    16
** Search for prog, func, conf file.
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    17
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    18
  $ man [<section>] <item>
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    19
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    20
** Search by specific keywords.
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    21
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    22
  $ man -k <keywords>
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    23
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    24
** Throw Emacs.
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    25
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    26
  M-x man RET [<section>] <item>
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    27
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    28
  M-x man RET -k SPACE <keywords>
3bd7637e1f68 Update doc about man.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    29
14
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    30
* Sections order.
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    31
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    32
NAME                - brief prog description
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    33
SYNOPSIS (USAGE)    - command line options in BNF
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    34
DESCRIPTION         - long prog description
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    35
OPTIONS             - long option descriptions
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    36
... misc sections ...
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    37
EXAMPLES
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    38
EXIT STATUS
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    39
ENVIRONMENT
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    40
AVAILABILITY        - whare search source, where home page
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    41
FILES               - list of files that has effect on program working
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    42
AUTHORS
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    43
COPYRIGHT
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    44
SEE ALSO
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    45
BUGS                - know issue, how report bug
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    46
HISTORY
77d9a6b493d8 Added man descr.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    47