Documentation Flashcards
Manual section purposes
Most Unix documentation can be read from the command line.
Classic manual sections:
- user commands (1),
- system calls (2), subroutine API provided by kernel directly
- library functions (3) implemented by user space
- devices (4) - device drivers
- file formats (5) - … used by the kernel
e. g. printf in 3 as a C library function (man 3 printf) but for the command line tool printf (man 1 printf) otherwise just get lowest numbered volume that knows this keyword.
man page
- synopsis
2. list of commands and options
output man page as postscript/html
xman - offers table of contents
info - use n/p/u to navigate tree, move to line and press enter to follow link.
Pressing spacebar – goes to end of page / go to next page
further documentation if there isn’t a man page or info page
/usr/share/doc or Web
Help/documentation browsers
man, apropos, xman, info
Plaintext file viewer
more, less
list/traverse directories, search
ls, find
copy, move/rename, remove, renew
files, link/shortcut files
cp, mv, rm, touch, ln
make/remove directories
mkdir, rmdir
concatenate/split files
cat, dd, head, tail
examine disk space used and free
du, df, quota, rquota
process table and system load
ps, top, free, uptime, w
interactive editors
vi, emacs, pico
C compilers
cc, gcc
project builder
make
compare files, apply patches
cmp, diff, patch