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
revision control systems
rcs, cvs, svn, git, hg, bzr
debuggers
adb, gdb
scripting languages
awk, perl, python, tcl
macro processors
m4, cpp
edit streams, replace characters
sed, tr
sort/search lines of text, extract columns
sort, grep, cut
text formatters
nroff, troff, tex, latex
electronic mail user agents
mail, pine, mh, exmh, elm
network tools
telnet, ftp, rlogin, finger,
talk, ping, traceroute, wget,
curl, ssh, scp, rsync, hostname,
host, ifconfig, route
VT100 terminal emulator
xterm
file packaging and compression
tar, cpio, compress, zip, gzip,
bzip2
builtin shell commands
echo, cd, pushd, popd, exit,
ulimit, time, history
builtin shell job control
fg, bg, jobs, kill
clocks
date, xclock
locate command file
which, whereis
clear screen, reset terminal
clear, reset
configure terminal driver
stty
graphics file viewers
display, ghostview, okular
graphics drawing tools
xfig, tgif, gimp, inkscape
graphics format converters
topnm, pnmto, [cd] jpeg
calculator
bc
change your password
passwd
change file permissions
chmod
scanner/parser generators
lex, yacc, flex, bison