AskApache » Search Results » Module+API

Terminal Escape Code Zen

AskApache — Wed, 13 Apr 2011 04:00:27 +0000

Lightning Strikes Twice!

LOL..

3rd Dimension Broken with Bash!

So 3D... it'll hurt you eyes! lol.. Man I am cracking up here. Ha but seriously those really do look 3D for terminal though.. I am actually really impressed. Sweet. Here is the little function I wrote to output that grey marble.

Just a word to the wise, start learning and going over some of these concepts, especially the code used in functions, I will be back in a followup that details actually using this stu.

This function is one of my favorites because it is so fast and useful. Like when designing a 256color prompt.

aa_256 ()
{
    local o x=`tput op` y=`printf %$((${COLUMNS}-6))s`;
    for i in {0..256};
    do
        o=00$i;
        echo -e ${o:${#o}-3:3} `tputm "setaf $i" "setab $i"`${y// /=}$x;
    done
}

Ya this is actually not very helpful or useful, but there you have it.

tputm ()
{
    local a;
    for a in "$@";
    do
        echo -en "${a}\n";
    done | tput -S
}

Some people call this function the grey bringer of death. Not really.

a256 ()
{
    ( x=`tput op` y=`printf %$((${COLUMNS}-6))slocal `;
    for i in {242..232} 232 232;
    do
        echo -en "`tput setaf $i;tput setab $i`${y}${x}`tput op`";
    done )
}

Fix screen

Helpful Ncurses Programs

Program Name	Description	Example Usage
infotocap	convert a terminfo description into a termcap description
tic	the terminfo entry-description compiler
toe	table of (terminfo) entries	`toe -a\|sort -d`
infocmp	compare or print out terminfo descriptions	`infocmp -a -L -1 -T -x`
capconvert	automated conversion from termcap to terminfo
stty	prints or changes terminal characteristics, such as baud rate.
clear	clears the terminal's screen
capconvert	automated conversion from termcap to terminfo

ALWAYS check out my functions!

This function will print out the terminal, show it's colors, etc.. I have some really nice ones in this article that I use for tmux, screen, and that sort of thing.

c ()
{
    tput clear;
    pm "$TERM: [colors:`tput colors`/`tput pairs`]";
    RC=`tput op` L1=$(L '=' $(( ${COLUMNS} - 25 )));
    for i in `seq ${1:-0} ${2:-16}`;
    do
        o="  $i";
        echo -e " ${o:${#o}-3:3} `tput setaf $i;tput setab $i`${L1}${RC}";
    done
}

Standard Capabilities

X.364 and iBCS2

\033c - RIS - full reset
\0337 - SC - save cursor
\0338 - RC - restore cursor
\033[r - RSR - not an X.364 mnemonic
\033[m - SGR0 - not an X.364 mnemonic
\033[2J - ED2 - clear page

Specified by ISO 2022

\033(0 - ISO DEC G0 - enable DEC graphics for G0
\033(A - ISO UK G0 - enable UK chars for G0
\033(B - ISO US G0 - enable US chars for G0
\033)0 - ISO DEC G1 - enable DEC graphics for G1
\033)A - ISO UK G1 - enable UK chars for G1
\033)B - ISO US G1 - enable US chars for G1

ISO 2022 charset switching:

ISO/IEC 2022:1994
"Character code structure and extension techniques"
ECMA-035
code structure
- =00..=1F C0 set of control characters
- =20..=7F G0 set of 94 or 96 graphic characters
- =80..=9F C1 set of control characters "C1 controls"
- =A0..=FF G1 set of 94 or 96 graphic characters
- ... G2 and G3
registration authority
- ISO/IEC 2375:1985 Procedure for registration of escape sequences
- "ECMA registry"
- ISO-IR registration number
- ftp://dkuug.dk/i18n/iso2375reg.txt
- Internaltional register of coded character sets to be used with escape sequences
- ISO/IEC JTC1/SC2/WG3
ISO-2022 terminals from Siemens
recode iso-2022..utf-8 not yet implemented
CJK charsets

DEC private controls widely supported by emulators

\033= - DECPAM - application keypad mode
\033> - DECPNM - normal keypad mode
\033< - DECANSI - enter ANSI mode
\033[!p - DECSTR - soft reset
\033 F - S7C1T - 7-bit controls

ECMA modes

ISO 2022

2 - AM - keyboard action mode
4 - IRM - insert/replace mode
12 - SRM - send/receive mode
20 - LNM - linefeed mode

DEC modes

1 - CKM - application cursor keys
2 - ANM - set VT52 mode
3 - COLM - 132-column mode
4 - SCLM - smooth scroll
5 - SCNM - reverse video mode
6 - OM - origin mode
7 - AWM - wraparound mode
8 - ARM - auto-repeat mode

ECMA attribute sequences

0 - NORMAL - normal
1 - +BOLD - bold on
2 - +DIM - dim on
3 - +ITALIC - italic on
4 - +UNDERLINE - underline on
5 - +BLINK - blink on
6 - +FASTBLINK - fastblink on
7 - +REVERSE - reverse on
8 - +INVISIBLE - invisible on
9 - +DELETED - deleted on
10 - MAIN-FONT - select primary font
11 - ALT-FONT-1 - select alternate font 1
12 - ALT-FONT-2 - select alternate font 2
13 - ALT-FONT-3 - select alternate font 3
14 - ALT-FONT-4 - select alternate font 4
15 - ALT-FONT-5 - select alternate font 5
16 - ALT-FONT-6 - select alternate font 6
17 - ALT-FONT-7 - select alternate font 7
18 - ALT-FONT-1 - select alternate font 1
19 - ALT-FONT-1 - select alternate font 1
20 - FRAKTUR - Fraktur font
21 - DOUBLEUNDER - double underline
22 - -DIM - dim off
23 - -ITALIC - italic off
24 - -UNDERLINE - underline off
25 - -BLINK - blink off
26 - -FASTBLINK - fastblink off
27 - -REVERSE - reverse off
28 - -INVISIBLE - invisible off
29 - -DELETED - deleted off

Init strings

Name	Description
`is1`	init_1string
`is2`	init_2string
`is3`	init_3string
`rs1`	reset_1string
`rs2`	reset_2string
`rs3`	reset_3string
`smcup`	enter_ca_mode
`rmcup`	exit_ca_mode

Cap strings

Name	Description
so	String of commands to enter standout mode.
se	String of commands to leave standout mode.
sg	Numeric capability, the width on the screen of the magic cookie. This capability is absent in terminals that record appearance modes character by character.
ms	Flag whose presence means that it is safe to move the cursor while the appearance modes are not in the normal state. If this flag is absent, programs should always reset the appearance modes to normal before moving the cursor.
xs	Flag whose presence means that the only way to reset appearance modes already on the screen is to clear to end of line. On a per-character terminal, you must clear the area where the modes are set. On a magic cookie terminal, you must clear an area containing the cookie. See the discussion above.
xt	Flag whose presence means that the cursor cannot be positioned right in front of a magic cookie, and that seis a command to delete the next magic cookie following the cursor. See discussion above.
mb	String of commands to enter blinking mode.
md	String of commands to enter double-bright mode.
mh	String of commands to enter half-bright mode.
mk	String of commands to enter invisible mode.
mp	String of commands to enter protected mode.
mr	String of commands to enter reverse-video mode.
me	String of commands to turn off all appearance modes, including standout mode and underline mode. On some terminals it also turns off alternate character set mode; on others, it may not. This capability must be present if any of mb... mris present.
as	String of commands to turn on alternate character set mode. This mode assigns some or all graphic characters an alternate picture on the screen. There is no standard as to what the alternate pictures look like.
ae	String of commands to turn off alternate character set mode.
sa	String of commands to turn on an arbitrary combination of appearance modes. It accepts 9 parameters, each of which controls a particular kind of appearance mode. A parameter should be 1 to turn its appearance mode on, or zero to turn that mode off. Most terminals do not support the sacapability, even among those that do have various appearance modes. The nine parameters are, in order, `standout` `underline` `reverse` `blink` `half-bright` `double-bright` `blank` `protect` `alt char set`

Variable and Function Index

For stty

BC: tgoto
ospeed: Output Padding
PC: Output Padding
tgetent: Find
tgetflag: Interrogate
tgetnum: Interrogate
tgetstr: Interrogate
tgoto: tgoto
tparam: tparam
tputs: Output Padding
UP: tgoto

Summary of Capability Names

Here are all the terminal capability names in alphabetical order with a brief description of each. For cross references to their definitions, see the index of capability names.

Name	Description
ae	String to turn off alternate character set mode.
al	String to insert a blank line before the cursor.
AL	String to insert `n` blank lines before the cursor.
am	Flag: output to last column wraps cursor to next line.
as	String to turn on alternate character set mode.like.
bc	Very obsolete alternative name for the lecapability.
bl	String to sound the bell.
bs	Obsolete flag: ASCII backspace may be used for leftward motion.
bt	String to move the cursor left to the previous hardware tab stop column.
bw	Flag: leat left margin wraps to end of previous line.
CC	String to change terminal's command character.
cd	String to clear the line the cursor is on, and following lines.
ce	String to clear from the cursor to the end of the line.
ch	String to position the cursor at column `c` in the same line.
cl	String to clear the entire screen and put cursor at upper left corner.
cm	String to position the cursor at line `l`, column `c`.
CM	String to position the cursor at line `l`, column `c`, relative to display memory.
co	Number: width of the screen.
cr	String to move cursor sideways to left margin.
cs	String to set the scroll region.
cS	Alternate form of string to set the scroll region.
ct	String to clear all tab stops.
cv	String to position the cursor at line `l` in the same column.
da	Flag: data scrolled off top of screen may be scrolled back.
db	Flag: data scrolled off bottom of screen may be scrolled back.
dB	Obsolete number: msec of padding needed for the backspace character.
dc	String to delete one character position at the cursor.
dC	Obsolete number: msec of padding needed for the carriage-return character.
DC	String to delete `n` characters starting at the cursor.
dF	Obsolete number: msec of padding needed for the formfeed character.
dl	String to delete the line the cursor is on.
DL	String to delete `n` lines starting with the cursor's line.
dm	String to enter delete mode.
dN	Obsolete number: msec of padding needed for the newline character.
do	String to move the cursor vertically down one line.
DO	String to move cursor vertically down `n` lines.
ds	String to disable the display of the status line.
dT	Obsolete number: msec of padding needed for the tab character.
ec	String of commands to clear `n` characters at cursor.
ed	String to exit delete mode.
ei	String to leave insert mode.
eo	Flag: output of a space can erase an overstrike.
es	Flag: other display commands work while writing the status line.
ff	String to advance to the next page, for a hardcopy terminal.
fs	String to move the cursor back from the status line to its previous position (outside the status line).
gn	Flag: this terminal type is generic, not real.
hc	Flag: hardcopy terminal.
hd	String to move the cursor down half a line.
ho	String to position cursor at upper left corner.
hs	Flag: the terminal has a status line.
hu	String to move the cursor up half a line.
hz	Flag: terminal cannot accept ~as output.
i1	String to initialize the terminal for each login session.
i3	String to initialize the terminal for each login session.
ic	String to insert one character position at the cursor.
IC	String to insert `n` character positions at the cursor.
if	String naming a file of commands to initialize the terminal.
im	String to enter insert mode.
in	Flag: outputting a space is different from moving over empty positions.
ip	String to output following an inserted character in insert mode.
is	String to initialize the terminal for each login session.
it	Number: initial spacing between hardware tab stop columns.
k0	String of input sent by function key 0 or 10.
k1 ... k9	Strings of input sent by function keys 1 through 9.
K1 ... K5	Strings sent by the five other keys in 3-by-3 array with arrows.
ka	String of input sent by the “clear all tabs” key.
kA	String of input sent by the “insert line” key.
kb	String of input sent by the “backspace” key.
kC	String of input sent by the “clear screen” key.
kd	String of input sent by typing the down-arrow key.
kD	String of input sent by the “delete character” key.
ke	String to make the function keys work locally.
kE	String of input sent by the “clear to end of line” key.
kF	String of input sent by the “scroll forward” key.
kh	String of input sent by typing the “home-position” key.
kH	String of input sent by the “home down” key.
kI	String of input sent by the “insert character” or “enter insert mode” key.
kl	String of input sent by typing the left-arrow key.
kL	String of input sent by the “delete line” key.
km	Flag: the terminal has a Meta key.
kM	String of input sent by the “exit insert mode” key.
kn	Numeric value, the number of numbered function keys.
kN	String of input sent by the “next page” key.
ko	Very obsolete string listing the terminal's named function keys.
kP	String of input sent by the “previous page” key.
kr	String of input sent by typing the right-arrow key.
kR	String of input sent by the “scroll reverse” key.
ks	String to make the function keys transmit.
kS	String of input sent by the “clear to end of screen” key.
kt	String of input sent by the “clear tab stop this column” key.
kT	String of input sent by the “set tab stop in this column” key.
ku	String of input sent by typing the up-arrow key.
l0	String on keyboard labelling function key 0 or 10.
l1 ... l9	Strings on keyboard labelling function keys 1 through 9.
le	String to move the cursor left one column.
LE	String to move cursor left `n` columns.
li	Number: height of the screen.
ll	String to position cursor at lower left corner.
lm	Number: lines of display memory.
LP	Flag: writing to last column of last line will not scroll.
mb	String to enter blinking mode.
md	String to enter double-bright mode.
me	String to turn off all appearance modes
mh	String to enter half-bright mode.
mi	Flag: cursor motion in insert mode is safe.
mk	String to enter invisible mode.
mm	String to enable the functioning of the Meta key.
mo	String to disable the functioning of the Meta key.
mp	String to enter protected mode.
mr	String to enter reverse-video mode.
ms	Flag: cursor motion in standout mode is safe.
nc	Obsolete flag: do not use ASCII carriage-return on this terminal.
nd	String to move the cursor right one column.
NF	Flag: do not use XON/XOFF flow control.
nl	Obsolete alternative name for the doand sfcapabilities.
ns	Flag: the terminal does not normally scroll for sequential output.
nw	String to move to start of next line, possibly clearing rest of old line.
os	Flag: terminal can overstrike.
pb	Number: the lowest baud rate at which padding is actually needed.
pc	String containing character for padding.
pf	String to terminate redirection of output to the printer.
po	String to redirect further output to the printer.
pO	String to redirect `n` characters ofoutput to the printer.
ps	String to print the screen on the attached printer.
rc	String to move to last saved cursor position.
RI	String to move cursor right `n` columns.
rp	String to output character `c` repeated `n` times.
rs	String to reset the terminal from any strange modes.
sa	String to turn on an arbitrary combination of appearance modes.
sc	String to save the current cursor position.
se	String to leave standout mode.
sf	String to scroll the screen one line up.
SF	String to scroll the screen `n` lines up.
sg	Number: width of magic standout cookie. Absent if magic cookies are not used.
so	String to enter standout mode.
sr	String to scroll the screen one line down.
SR	String to scroll the screen `n` line down.
st	String to set tab stop at current cursor column on all lines. programs.
ta	String to move the cursor right to the next hardware tab stop column.
te	String to return terminal to settings for sequential output.
ti	String to initialize terminal for random cursor motion.
ts	String to move the terminal cursor into the status line.
uc	String to underline one character and move cursor right.
ue	String to turn off underline mode
ug	Number: width of underlining magic cookie. Absent if underlining doesn't use magic cookies.
ul	Flag: underline by overstriking with an underscore.
up	String to move the cursor vertically up one line.
UP	String to move cursor vertically up `n` lines.
us	String to turn on underline mode
vb	String to make the screen flash.
ve	String to return the cursor to normal.
vi	String to make the cursor invisible.
vs	String to enhance the cursor.
wi	String to set the terminal output screen window.
ws	Number: the width of the status line.
xb	Flag: superbee terminal.
xn	Flag: cursor wraps in a strange way.
xs	Flag: clearing a line is the only way to clear the appearance modes of positions in that line (or, only way to remove magic cookies on that line).
xt	Flag: Teleray 1061; several strange characteristics.

Variable and Function Index

BC: tgoto
ospeed: Output Padding
PC: Output Padding
tgetent: Find
tgetflag: Interrogate
tgetnum: Interrogate
tgetstr: Interrogate
tgoto: tgoto
tparam: tparam
tputs: Output Padding
UP: tgoto

ae: Standout
AL: Insdel Line
al: Insdel Line
am: Wrapping
as: Standout
bc: Cursor Motion
bl: Bell
bs: Cursor Motion
bt: Cursor Motion
bw: Cursor Motion
CC: Basic
cd: Clearing
ce: Clearing
ch: Cursor Motion
cl: Clearing
CM: Cursor Motion
cm: Cursor Motion
co: Screen Size
cr: Cursor Motion
cS: Scrolling
cs: Scrolling
ct: Initialization
cv: Cursor Motion
da: Scrolling
dB: Pad Specs
db: Scrolling
dC: Pad Specs
DC: Insdel Char
dc: Insdel Char
dF: Pad Specs
DL: Insdel Line
dl: Insdel Line
dm: Insdel Char
dN: Pad Specs
DO: Cursor Motion
do: Cursor Motion
ds: Status Line
dT: Pad Specs
ec: Clearing
ed: Insdel Char
ei: Insdel Char
eo: Basic
es: Status Line
ff: Cursor Motion
fs: Status Line
gn: Basic
hc: Basic
hd: Half-Line
ho: Cursor Motion
hs: Status Line
hu: Half-Line
hz: Basic
i1: Initialization
i3: Initialization
IC: Insdel Char
ic: Insdel Char
if: Initialization
im: Insdel Char
in: Insdel Char
ip: Insdel Char
is: Initialization
it: Initialization
K1...K5: Keypad
k1...k9: Keypad
kA...kT: Keypad
ka...ku: Keypad
km: Meta Key
l0...l9: Keypad
LE: Cursor Motion
le: Cursor Motion
li: Screen Size
ll: Cursor Motion
lm: Scrolling
LP: Wrapping
mb: Standout
md: Standout
me: Standout
mh: Standout
mi: Insdel Char
mk: Standout
mm: Meta Key
mo: Meta Key
mp: Standout
mr: Standout
ms: Underlining
ms: Standout
nc: Cursor Motion
nd: Cursor Motion
NF: Initialization
nl: Cursor Motion
ns: Scrolling
nw: Cursor Motion
os: Basic
pb: Pad Specs
pc: Pad Specs
pf: Printer
pO: Printer
po: Printer
ps: Printer
rc: Cursor Motion
RI: Cursor Motion
rp: Basic
rs: Initialization
sa: Standout
sc: Cursor Motion
se: Standout
SF: Scrolling
sf: Scrolling
sg: Standout
so: Standout
SR: Scrolling
sr: Scrolling
st: Initialization
ta: Cursor Motion
te: Initialization
ti: Initialization
ts: Status Line
uc: Underlining
ue: Underlining
ug: Underlining
ul: Underlining
UP: Cursor Motion
up: Cursor Motion
us: Underlining
vb: Bell
ve: Cursor Visibility
vi: Cursor Visibility
vs: Cursor Visibility
wi: Windows
ws: Status Line
xb: Basic
xn: Wrapping
xs: Standout
xt: Standout
xt: Cursor Motion

Basic: Basic characteristics.
Screen Size: Screen size, and what happens when it changes.
Cursor Motion: Various ways to move the cursor.
Wrapping: What happens if you write a character in the last column.
Scrolling: Pushing text up and down on the screen.
Windows: Limiting the part of the window that output affects.
Clearing: Erasing one or many lines.
Insdel Line: Making new blank lines in mid-screen; deleting lines.
Insdel Char: Inserting and deleting characters within a line.
Standout: Highlighting some of the text.
Underlining: Underlining some of the text.
Cursor Visibility: Making the cursor more or less easy to spot.
Bell: Attracts user's attention; not localized on the screen.
Keypad: Recognizing when function keys or arrows are typed.
Meta Key: META acts like an extra shift key.
Initialization: Commands used to initialize or reset the terminal.
Pad Specs: Info for the kernel on how much padding is needed.
Status Line: A status line displays background information.
Half-Line: Moving by half-lines, for superscripts and subscripts.
Printer: Controlling auxiliary printers of display terminals.

Translated Term Capabilities

This is helpful so you can understand what a term cap does, by looking at the long name.

Tput Name	Terminfo Long Name
@7	key_end
AB	set_a_background
AF	set_a_foreground
AL	parm_insert_line
AX	AX
Co	max_colors
DC	parm_dch
DL	parm_delete_line
DO	parm_down_cursor
E0	E0
F1	key_f11
F2	key_f12
G0	G0
HC	5i
IC	parm_ich
Ic	initialize_color
Km	delete_line
LE	parm_left_cursor
NC	no_color_video
ND	MT
NP	NL
RI	parm_right_cursor
S0	S0
UP	parm_up_cursor
YA	NR
YC	YB
YE	YD
YG	YF
ac	acs_chars
ae	exit_alt_charset_mode
al	insert_line
am	auto_right_margin
as	enter_alt_charset_mode
back_color_erase	backspaces_with_bs
bl	bell
bs	eat_newline_glitch
bt	back_tab
bw	auto_left_margin
cb	clr_bol
cc	can_change
cd	clr_eos
ce	clr_eol
cl	clear_screen
cm	cursor_address
co	columns
col_addr_glitch	ceol_standout_glitch
cpi_changes_res	cr_cancels_micro_mode
cr	carriage_return
cs	change_scroll_region
ct	clear_all_tabs
cursor_up	scroll_reverse
da	crt_no_scrolling
db	dest_tabs_magic_smso
dc	delete_character
dl	key_mouse
do	cursor_down
eA	ena_acs
ei	exit_insert_mode
eo	erase_overstrike
es	generic_type
gn	gnu_has_meta_key
hard_copy	hard_cursor
has_meta_key	has_hardware_tabs
has_status_line	has_print_wheel
hl	hc
ho	cursor_home
hs	hue_lightness_saturation
im	enter_insert_mode
in	hz
insert_null_glitch	linefeed_is_newline
is	init_2string
it	init_tabs
k1	key_f1
k2	key_f2
k3	key_f3
k4	key_f4
k5	key_f5
k6	key_f6
k7	key_f7
k8	key_f8
k9	key_f9
k;	key_f10
kB	key_btab
kD	key_dc
kI	key_ic
kN	key_npage
kP	key_ppage
kb	cursor_left
kd	key_down
ke	keypad_local
kh	key_home
kl	key_left
kr	key_right
ks	keypad_xmit
ku	key_up
le	key_backspace
li	lines
mb	enter_blink_mode
md	enter_bold_mode
me	exit_attribute_mode
memory_above	lpi_changes_res
mi	km
move_insert_mode	move_standout_mode
mr	enter_reverse_mode
nc	memory_below
nd	cursor_right
needs_xon_xoff	no_correctly_working_cr
no_pad_char	no_esc_ctlc
non_rev_rmcup	non_dest_scroll_region
nw	newline
nx	ns
op	orig_pair
os	over_strike
pa	max_pairs
prtr_silent	return_does_clr_eol
pt	ms
r2	reset_2string
rc	restore_cursor
row_addr_glitch	semi_auto_right_margin
sa	set_attributes
sc	save_cursor
se	exit_standout_mode
sf	scroll_forward
so	enter_standout_mode
st	set_tab
ta	tab
te	exit_ca_mode
ti	enter_ca_mode
tilde_glitch	status_line_esc_ok
ue	exit_underline_mode
ul	transparent_underline
up	sr
us	enter_underline_mode
vb	flash_screen
ve	cursor_normal
vi	cursor_invisible
vs	cursor_visible
xn	ut
xo	xb
xr	xon_xoff
xt	xs

List of All Terminals

You can view this list with the following command:

$ toe -a|sort -d

VT100 keypad Diagram

VT100 LINK

Here's a diagram of the VT100 keypad keys with their bindings. The top line is the name of the key (some DEC keyboards have the keys labelled somewhat differently, like GOLD instead of PF1, but this is the most "official" name). The second line is the escape sequence it generates in Application Keypad mode (where "$" means the ESC character). The third line contains two items, first the mapping of the key in terminfo, and then in termcap.

   _______________________________________
  |   PF1   |   PF2   |   PF3   |   PF4   |
  |   $OP   |   $OQ   |   $OR   |   $OS   |
  |_kf1__k1_|_kf2__k2_|_kf3__k3_|_kf4__k4_|
  |    7         8         9         -    |
  |   $Ow   |   $Ox   |   $Oy   |   $Om   |
  |_kf9__k9_|_kf10_k;_|_kf0__k0_|_________|
  |    4    |    5    |    6    |    ,    |
  |   $Ot   |   $Ou   |   $Ov   |   $Ol   |
  |_kf5__k5_|_kf6__k6_|_kf7__k7_|_kf8__k8_|
  |    1    |    2    |    3    |         |
  |   $Oq   |   $Or   |   $Os   |  enter  |
  |_ka1__K1_|_kb2__K2_|_ka3__K3_|  $OM    |
  |         0         |   .     |         |
  |        $Op        |  $On    |         |
  |___kc1_______K4____|_kc3__K5_|_kent_@8_|

A better adaptation to modern keyboards such as the PC's, which have a dozen function keys and the keypad 2,4,6,8 keys are labeled with arrows keys, is to use the 5-key arrangement to model the arrow keys as suggested in the terminfo guidelines:

   _______________________________________
  |   PF1   |   PF2   |   PF3   |   PF4   |
  |   $OP   |   $OQ   |   $OR   |   $OS   |
  |_kf1__k1_|_kf2__k2_|_kf3__k3_|_kf4__k4_|
  |    7         8         9         -    |
  |   $Ow   |   $Ox   |   $Oy   |   $Om   |
  |_ka1__K1_|_________|_ka3__K3_|_________|
  |    4    |    5    |    6    |    ,    |
  |   $Ot   |   $Ou   |   $Ov   |   $Ol   |
  |_________|_kb2__K2_|_________|_________|
  |    1    |    2    |    3    |         |
  |   $Oq   |   $Or   |   $Os   |  enter  |
  |_kc1__K4_|_________|_kc3__K5_|  $OM    |
  |         0         |   .     |         |
  |        $Op        |  $On    |         |
  |___________________|_________|_kent_@8_|

SGR parameter values

Name	Description
`0`	default mode (attributes off)
`1`	bold
`2`	dim
`3`	italicized
`4`	underlined
`5`	slow blink
`6`	fast blink
`7`	reverse video
`8`	invisible
`9`	crossed-out (marked for deletion)
`10`	primary font [10 + n (n in 1..9) = nth alternative font]
`20`	Fraktur
`21`	double underline
`22`	turn off 2
`23`	turn off 3
`24`	turn off 4
`25`	turn off 5
`26`	proportional spacing
`27`	turn off 7
`28`	turn off 8
`29`	turn off 9
`30`	black fg
`31`	red fg
`32`	green fg
`33`	yellow fg
`34`	blue fg
`35`	magenta fg
`36`	cyan fg
`37`	white fg
`38`	set fg color as in CCIT T.416
`39`	set default fg color
`40`	black bg
`41`	red bg
`42`	green bg
`43`	yellow bg
`44`	blue bg
`45`	magenta bg
`46`	cyan bg
`47`	white bg
`48`	set bg color as in CCIT T.416
`39`	set default bg color
`50`	turn off 26
`51`	framed
`52`	encircled
`53`	overlined
`54`	turn off 51 & 52
`55`	not overlined
`56-59`	reserved
`61-65`	variable highlights for ideograms.

Sequence     Sequence                             Parameter   or
Mnemonic     Name              Sequence           Value      Mode   terminfo
-----------------------------------------------------------------------------
APC  Applicatn Program Command \E _                -         Delim  -
BEL  Bell *                    ^G                  -         -      bel
BPH  Break Permitted Here *    \E B                -         *      -
BS   Backpace *                ^H                  -         EF     -
CAN  Cancel *                  ^X                  -         -      -   (A)
CBT  Cursor Backward Tab       \E [ Pn Z           1         eF     cbt
CCH  Cancel Previous Character \E T                -         -      -
CHA  Cursor Horizntal Absolute \E [ Pn G           1         eF     hpa (B)
CHT  Cursor Horizontal Tab     \E [ Pn I           1         eF     tab (C)
CMD  Coding Method Delimiter * \E
CNL  Cursor Next Line          \E [ Pn E           1         eF     nel (D)
CPL  Cursor Preceding Line     \E [ Pn F           1         eF     -
CPR  Cursor Position Report    \E [ Pn ; Pn R      1, 1      -      -   (E)
CSI  Control Sequence Intro    \E [                -         Intro  -
CTC  Cursor Tabulation Control \E [ Ps W           0         eF     -   (F)
CUB  Cursor Backward           \E [ Pn D           1         eF     cub
CUD  Cursor Down               \E [ Pn B           1         eF     cud
CUF  Cursor Forward            \E [ Pn C           1         eF     cuf
CUP  Cursor Position           \E [ Pn ; Pn H      1, 1      eF     cup (G)
CUU  Cursor Up                 \E [ Pn A           1         eF     cuu
CVT  Cursor Vertical Tab       \E [ Pn Y           -         eF     -   (H)
DA   Device Attributes         \E [ Pn c           0         -      -
DAQ  Define Area Qualification \E [ Ps o           0         -      -
DCH  Delete Character          \E [ Pn P           1         eF     dch
DCS  Device Control String     \E P                -         Delim  -
DL   Delete Line               \E [ Pn M           1         eF     dl
DLE  Data Link Escape *        ^P                  -         -      -
DMI  Disable Manual Input      \E \                -         Fs     -
DSR  Device Status Report      \E [ Ps n           0         -      -   (I)
DTA  Dimension Text Area *     \E [ Pn ; Pn SPC T  -         PC     -
EA   Erase in Area             \E [ Ps O           0         eF     -   (J)
ECH  Erase Character           \E [ Pn X           1         eF     ech
ED   Erase in Display          \E [ Ps J           0         eF     ed  (J)
EF   Erase in Field            \E [ Ps N           0         eF     -
EL   Erase in Line             \E [ Ps K           0         eF     el  (J)
EM   End of Medium *           ^Y                  -         -      -
EMI  Enable Manual Input       \E b                          Fs     -
ENQ  Enquire                   ^E                  -         -      -
EOT  End Of Transmission       ^D                  -         *      -
EPA  End of Protected Area     \E W                -         -      -   (K)
ESA  End of Selected Area      \E G                -         -      -
ESC  Escape                    ^[                  -         -      -
ETB  End Transmission Block    ^W                  -         -      -
ETX  End of Text               ^C                  -         -      -
FF   Form Feed                 ^L                  -         -      -
FNK  Function Key *            \E [ Pn SPC W       -         -      -
GCC  Graphic Char Combination* \E [ Pn ; Pn SPC B  -         -      -
FNT  Font Selection            \E [ Pn ; Pn SPC D  0, 0      FE     -
GSM  Graphic Size Modify       \E [ Pn ; Pn SPC B  100, 100  FE     -   (L)
GSS  Graphic Size Selection    \E [ Pn SPC C       none      FE     -
HPA  Horz Position Absolute    \E [ Pn `           1         FE     -   (B)
HPB  Char Position Backward    \E [ j              1         FE     -
HPR  Horz Position Relative    \E [ Pn a           1         FE     -   (M)
HT   Horizontal Tab *          ^I                  -         FE     -   (N)
HTJ  Horz Tab w/Justification  \E I                -         FE     -
HTS  Horizontal Tab Set        \E H                -         FE     hts
HVP  Horz & Vertical Position  \E [ Pn ; Pn f      1, 1      FE     -   (G)
ICH  Insert Character          \E [ Pn @           1         eF     ich
IDCS ID Device Control String  \E [ SPC O          -         *      -
IGS  ID Graphic Subrepertoire  \E [ SPC M          -         *      -
IL   Insert Line               \E [ Pn L           1         eF     il
IND  Index                     \E D                -         FE     -
INT  Interrupt                 \E a                -         Fs     -
JFY  Justify                   \E [ Ps SPC F       0         FE     -
IS1  Info Separator #1 *       ^_                  -         *      -
IS2  Info Separator #1 *       ^^                  -         *      -
IS3  Info Separator #1 *       ^]                  -         *      -
IS4  Info Separator #1 *       ^\                  -         *      -
LF   Line Feed                 ^J                  -         -      -
LS1R Locking Shift Right 1 *   \E ~                -         -      -
LS2  Locking Shift 2 *         \E n                -         -      -
LS2R Locking Shift Right 2 *   \E }                -         -      -
LS3  Locking Shift 3 *         \E o                -         -      -
LS3R Locking Shift Right 3 *   \E |                -         -      -
MC   Media Copy                \E [ Ps i           0         -      -   (S)
MW   Message Waiting           \E U                -         -      -
NAK  Negative Acknowledge *    ^U                  -         *      -
NBH  No Break Here *           \E C                -         -      -
NEL  Next Line                 \E E                -         FE     nel (D)
NP   Next Page                 \E [ Pn U           1         eF     -
NUL  Null *                    ^@                  -         -      -
OSC  Operating System Command  \E ]                -         Delim  -
PEC  Pres. Expand/Contract *   \E Pn SPC Z         0         -      -
PFS  Page Format Selection *   \E Pn SPC J         0         -      -
PLD  Partial Line Down         \E K                -         FE     -   (T)
PLU  Partial Line Up           \E L                -         FE     -   (U)
PM   Privacy Message           \E ^                -         Delim  -
PP   Preceding Page            \E [ Pn V           1         eF     -
PPA  Page Position Absolute *  \E [ Pn SPC P       1         FE     -
PPB  Page Position Backward *  \E [ Pn SPC R       1         FE     -
PPR  Page Position Forward *   \E [ Pn SPC Q       1         FE     -
PTX  Parallel Texts *          \E [ \              -         -      -
PU1  Private Use 1             \E Q                -         -      -
PU2  Private Use 2             \E R                -         -      -
QUAD Typographic Quadding      \E [ Ps SPC H       0         FE     -
REP  Repeat Char or Control    \E [ Pn b           1         -      rep
RI   Reverse Index             \E M                -         FE     -   (V)
RIS  Reset to Initial State    \E c                -         Fs     -
RM   Reset Mode *              \E [ Ps l           -         -      -   (W)
SACS Set Add. Char. Sep. *     \E [ Pn SPC /       0         -      -
SAPV Sel. Alt. Present. Var. * \E [ Ps SPC ]       0         -      -   (X)
SCI  Single-Char Introducer    \E Z                -         -      -
SCO  Sel. Char. Orientation *  \E [ Pn ; Pn SPC k  -         -      -
SCS  Set Char. Spacing *       \E [ Pn SPC g       -         -      -
SD   Scroll Down               \E [ Pn T           1         eF     rin
SDS  Start Directed String *   \E [ Pn ]           1         -      -
SEE  Select Editing Extent     \E [ Ps Q           0         -      -   (Y)
SEF  Sheet Eject & Feed *  \E [ Ps ; Ps SPC Y  0,0       -      -
SGR  Select Graphic Rendition  \E [ Ps m           0         FE     sgr (O)
SHS  Select Char. Spacing *    \E [ Ps SPC K       0         -      -
SI   Shift In                  ^O                  -         -      -   (P)
SIMD Sel. Imp. Move Direct. *  \E [ Ps ^           -         -      -
SL   Scroll Left               \E [ Pn SPC @       1         eF     -
SLH  Set Line Home *           \E [ Pn SPC U       -         -      -
SLL  Set Line Limit *          \E [ Pn SPC V       -         -      -
SLS  Set Line Spacing *        \E [ Pn SPC h       -         -      -
SM   Select Mode               \E [ Ps h           none      -      -   (W)
SO   Shift Out                 ^N                  -         -      -   (Q)
SOH  Start Of Heading *        ^A                  -         -      -
SOS  Start of String *         \E X                -         -      -
SPA  Start of Protected Area   \E V                -         -      -   (Z)
SPD  Select Pres. Direction *  \E [ Ps ; Ps SPC S  0,0       -      -
SPH  Set Page Home *           \E [ Ps SPC G       -         -      -
SPI  Spacing Increment         \E [ Pn ; Pn SPC G  none      FE     -
SPL  Set Page Limit *          \E [ Ps SPC j       -         -      -
SPQR Set Pr. Qual. & Rapid. *  \E [ Ps SPC X       0         -      -
SR   Scroll Right              \E [ Pn SPC A       1         eF     -
SRCS Set Reduced Char. Sep. *  \E [ Pn SPC f       0         -      -
SRS  Start Reversed String *   \E [ Ps [           0         -      -
SSA  Start of Selected Area    \E F                -         -      -
SSU  Select Size Unit *        \E [ Pn SPC I       0         -      -
SSW  Set Space Width *         \E [ Pn SPC [       none      -      -
SS2  Single Shift 2 (G2 set)   \E N                -         Intro  -
SS3  Single Shift 3 (G3 set)   \E O                -         Intro  -
ST   String Terminator         \E \                -         Delim  -
STAB Selective Tabulation *    \E [ Pn SPC ^       -         -      -
STS  Set Transmit State        \E S                -         -      -
STX  Start pf Text *           ^B                  -         -      -
SU   Scroll Up                 \E [ Pn S           1         eF     indn
SUB  Substitute *              ^Z                  -         -      -
SVS  Select Line Spacing *     \E [ Pn SPC \       1         -      -
SYN  Synchronous Idle *        ^F                  -         -      -
TAC  Tabul. Aligned Centered * \E [ Pn SPC b       -         -      -
TALE Tabul. Al. Leading Edge * \E [ Pn SPC a       -         -      -
TATE Tabul. Al. Trailing Edge* \E [ Pn SPC `       -         -      -
TBC  Tab Clear                 \E [ Ps g           0         FE     tbc
TCC  Tabul. Centered on Char * \E [ Pn SPC c       -         -      -
TSR  Tabulation Stop Remove  * \E [ Pn SPC d       -         FE     -
TSS  Thin Space Specification  \E [ Pn SC E        none      FE     -
VPA  Vert. Position Absolute   \E [ Pn d           1         FE     vpa
VPB  Line Position Backward *  \E [ Pn k           1         FE     -
VPR  Vert. Position Relative   \E [ Pn e           1         FE     -   (R)
VPR  Vert. Position Relative   \E [ Pn e           1         FE     -   (R)
VT   Vertical Tabulation *     ^K                  -         FE     -
VTS  Vertical Tabulation Set   \E J                -         FE     -

Basic Characteristics

This section documents the capabilities that describe the basic and nature of the terminal, and also those that are relevant to the output of graphic characters.

Name	Description
os	Flag whose presence means that the terminal can overstrike. This means that outputting a graphic character does not erase whatever was present in the same character position before. The terminals that can overstrike include printing terminals, storage tubes (all obsolete nowadays), and many bit-map displays.
eo	Flag whose presence means that outputting a space erases a character position even if the terminal supports overstriking. If this flag is not present and overstriking is supported, output of a space has no effect except to move the cursor. (On terminals that do not support overstriking, you can always assume that outputting a space at a position erases whatever character was previously displayed there.)
gn	Flag whose presence means that this terminal type is a generic type which does not really describe any particular terminal. Generic types are intended for use as the default type assigned when the user connects to the system, with the intention that the user should specify what type he really has. One example of a generic type is the type `network`. Since the generic type cannot say how to do anything interesting with the terminal, termcap-using programs will always find that the terminal is too weak to be supported if the user has failed to specify a real terminal type in place of the generic one. The gnflag directs these programs to use a different error message: “You have not specified your real terminal type”, rather than “Your terminal is not powerful enough to be used”.
hc	Flag whose presence means this is a hardcopy terminal.
rp	String of commands to output a graphic character `c`, repeated `n` times. The first parameter value is the ASCII code for the desired character, and the second parameter is the number of times to repeat the character. Often this command requires padding proportional to the number of times the character is repeated. This effect can be had by using parameter arithmetic with `%`-sequences to compute the amount of padding, then generating the result as a number at the front of the string so that `tputs` will treat it as padding.
hz	Flag whose presence means that the ASCII character cannot be output on this terminal because it is used for display commands. Programs handle this flag by checking all text to be output and replacing each ~with some other character(s). If this is not done, the screen will be thoroughly garbled. The old Hazeltine terminals that required such treatment are probably very rare today, so you might as well not bother to support this flag.
CC	String whose presence means the terminal has a settable command character. The value of the string is the default command character (which is usually ). All the strings of commands in the terminal description should be written to use the default command character. If you are writing an application program that changes the command character, use the CCcapability to figure out how to translate all the display commands to work with the new command character. Most programs have no reason to look at the CCcapability.
xb	Flag whose presence identifies Superbee terminals which are unable to transmit the characters and `Control-C`. Programs which support this flag are supposed to check the input for the code sequences sent by the and keys, and pretend that or `Control-C` (respectively) had been read. But this flag is obsolete, and not worth supporting.

7bit vs. 8bit

These recommendations are optional. IBCS2 allows the leading escape to # be either the 7-bit \E[ or 8-bit \0233 introducer, in accordance with # the ANSI X.364/ISO 6429/ECMA-48 standard.

1.6.1 Describing the Encoding
For example, the cm string for a standard ANSI terminal is written as \E[%i%d;%dH. (\E stands for .) cm by convention always requires two parameters, the vertical and horizontal goal positions, so this string specifies the encoding of two parameters. Here %i increments the two values supplied, and each %d encodes one of the values in decimal. If the cursor position values 20,58 are encoded with this string, the result is \E[21;59H.

First, here are the %-sequences that generate output. Except for %%, each of them encodes one parameter and advances the pointer to the following parameter.

%% Output a single %. This is the only way to represent a literal % in a terminal command with parameters. %% does not use up a parameter.
%d As in printf, output the next parameter in decimal.
%2 Like %02d in printf: output the next parameter in decimal, and always use at least two digits.
%3 Like %03d in printf: output the next parameter in decimal, and always use at least three digits. Note that %4 and so on are _not_ defined.
%. Output the next parameter as a single character whose ASCII code is the parameter value. Like %c in printf.
%+CHAR Add the next parameter to the character CHAR, and output the resulting character. For example, %+ represents 0 as a space, 1 as !, etc.

The following %-sequences specify alteration of the parameters (their values, or their order) rather than encoding a parameter for output. They generate no output; they are used only for their side effects on the parameters. Also, they do not advance the "next parameter" pointer except as explicitly stated. Only %i, %r and %> are defined in standard Unix termcap. The others are GNU extensions.

%i Increment the next two parameters. This is used for terminals that expect cursor positions in origin 1. For example, %i%d,%d would output two parameters with 1 for 0, 2 for 1, etc.
%r Interchange the next two parameters. This is used for terminals whose cursor positioning command expects the horizontal position first.
%s Skip the next parameter. Do not output anything.
%b Back up one parameter. The last parameter used will become once again the next parameter to be output, and the next output command will use it. Using %b more than once, you can back up any number of parameters, and you can refer to each parameter any number of times.
%>C1C2 Conditionally increment the next parameter. Here C1 and C2 are characters which stand for their ASCII codes as numbers. If the next parameter is greater than the ASCII code of C1, the ASCII code of C2 is added to it.
%a OP TYPE POS Perform arithmetic on the next parameter, do not use it up, and do not output anything. Here OP specifies the arithmetic operation, while TYPE and POS together specify the other operand.

Spaces are used above to separate the operands for clarity; the spaces don't appear in the data base, where this sequence is exactly five characters long. The character OP says what kind of arithmetic operation to perform. It can be any of these characters:

= - assign a value to the next parameter, ignoring its old value. The new value comes from the other operand.
+ - add the other operand to the next parameter.
- - subtract the other operand from the next parameter.
* - multiply the next parameter by the other operand.
/ - divide the next parameter by the other operand.

The "other operand" may be another parameter's value or a constant; the character TYPE says which. It can be:

p - Use another parameter. The character POS says which parameter to use. Subtract 64 from its ASCII code to get the position of the desired parameter relative to this one. Thus, the character A as POS means the parameter after the next one; the character ? means the parameter before the next one.
c - Use a constant value. The character POS specifies the value of the constant. The 0200 bit is cleared out, so that 0200 can be used to represent zero.

The following %-sequences are special purpose hacks to compensate for the weird designs of obscure terminals. They modify the next parameter or the next two parameters but do not generate output and do not use up any parameters. %m is a GNU extension; the others are defined in standard Unix termcap.

%n - Exclusive-or the next parameter with 0140, and likewise the parameter after next.
%m - Complement all the bits of the next parameter and the parameter after next.
%B - Encode the next parameter in BCD. It alters the value of the parameter by adding six times the quotient of the parameter by ten. Here is a C statement that shows how the new value is computed: PARM = (PARM / 10) * 16 + PARM % 10;
%D - Transform the next parameter as needed by Delta Data terminals. This involves subtracting twice the remainder of the parameter by 16. PARM -= 2 * (PARM % 16);

Terminal Type Name Conventions

Here is a list of standard suffixes and their conventional meanings:

-w - Short for "wide". This is a mode that gives the terminal more columns than usual. This is normally a user option.
-am - "Automatic margins". This is an alternate description for use when the terminal's margin-wrap switch is on; it contains the am flag. The implication is that normally the switch is off and the usual description for the terminal says that the switch is off.
-nam - "No automatic margins". The opposite of -am, this names an alternative description which lacks the am flag. This implies that the terminal is normally operated with the margin-wrap switch turned on, and the normal description of the terminal says so.
-na - "No arrows". This terminal description initializes the terminal to keep its arrow keys in local mode. This is a user option.
-rv - "Reverse video". This terminal description causes text output for normal video to appear as reverse, and text output for reverse video to come out as normal. Often this description differs from the usual one by interchanging the two strings which turn reverse video on and off.

This is a user option; you can choose either the "reverse video" variant terminal type or the normal terminal type, and termcap will obey.

-s - "Status". Says to enable use of a status line which ordinary output does not touch (*note Status Line::).

Some terminals have a special line that is used only as a status line. For these terminals, there is no need for an -s variant; the status line commands should be defined by default. On other terminals, enabling a status line means removing one screen line from ordinary use and reducing the effective screen height. For these terminals, the user can choose the -s variant type to request use of a status line.

-NLINES - Says to operate with NLINES lines on the screen, for terminals such as the Ambassador which provide this as an option. Normally this is a user option; by choosing the terminal type, you control how many lines termcap will use.
-NPAGESp - Says that the terminal has NPAGES pages worth of screen memory, for terminals where this is a hardware option.
-unk - Says that description is not for direct use, but only for reference in tc capabilities. Such a description is a kind of subroutine, because it describes the common characteristics of several variant descriptions that would use other suffixes in place of -unk.

MS-DOS ANSI.SYS

Here is a description of the color and attribute controls supported in the ANSI.SYS driver under MS-DOS. Most console drivers and ANSI terminal emulators for Intel boxes obey these. They are a proper subset of the ECMA-48 escapes.

Bright black becomes gray, bright brown becomes yellow. These coincide with the prescriptions of the ISO 6429/ECMA-48 standard. * If the 5 attribute is on and you set a background color (40-47) it is supposed to enable bright background.

0        all attributes off
1        foreground bright
4        underscore on
5        blink on/background bright (not reliable with brown)
7        reverse-video
8        set blank (non-display)
10       set primary font
11       set first alternate font (on PCs, display ROM characters 1-31)
12       set second alternate font (on PCs, display IBM high-half chars)
3n       set foreground color       / 0=black, 1=red,     2=green, 3=brown,
4n       set background color       \ 4=blue,  5=magenta, 6=cyan,  7=white

STTY

Stty Control Settings

Name	Description
parenb	`parenb` Generate parity bit in output and expect parity bit in input. May be negated.
parodd	Set odd parity (even if negated). May be negated.
cs5, cs6, cs7, cs8	Set character size to 5, 6, 7, or 8 bits.
hup, hupcl	Send a hangup signal when the last process closes the tty. May be negated.
cstopb	Use two stop bits per character (one if negated). May be negated.
cread	Allow input to be received. May be negated.
clocal	Disable modem control signals. May be negated.
crtscts	Enable RTS/CTS flow control. Disables DTR/DSR flow control. Non-POSIX. May be negated.
cdtrdsr	Enable DTR/DSR flow control. Disables RTS/CTS flow control. Non-POSIX. May be negated. No stty-readable form available. It needs to be supported by device. Usage on device without DTR/DSR support could lead to an error and failure of `stty`.

Stty Input settings

Name	Description
ignbrk	Ignore break characters. May be negated.
brkint	Make breaks cause an interrupt signal. May be negated.
ignpar	Ignore characters with parity errors. May be negated.
parmrk	Mark parity errors (with a 255-0-character sequence). May be negated.
inpck	Enable input parity checking. May be negated.
istrip	Clear high (8th) bit of input characters. May be negated.
inlcr	Translate newline to carriage return. May be negated.
igncr	Ignore carriage return. May be negated.
icrnl	Translate carriage return to newline. May be negated.
iutf8	Assume input characters are UTF-8 encoded. May be negated.
ixon	Enable XON/XOFF flow control (that is, `CTRL-S`/`CTRL-Q`). May be negated.
ixoff, tandem	Enable sending of `stop` character when the system input buffer is almost full, and `start` character when it becomes almost empty again. May be negated.
iuclc	Translate uppercase characters to lowercase. Non-POSIX. May be negated.
ixany	Allow any character to restart output (only the start character if negated). Non-POSIX. May be negated.
imaxbel	Enable beeping and not flushing input buffer if a character arrives when the input buffer is full. Non-POSIX. May be negated.

Stty Output settings

These arguments specify output-related operations.

Name	Description
opost	Postprocess output. May be negated.
olcuc	Translate lowercase characters to uppercase. Non-POSIX. May be negated.
ocrnl	Translate carriage return to newline. Non-POSIX. May be negated.
onlcr	Translate newline to carriage return-newline. Non-POSIX. May be negated.
onocr	Do not print carriage returns in the first column. Non-POSIX. May be negated.
onlret	Newline performs a carriage return. Non-POSIX. May be negated.
ofill	Use fill (padding) characters instead of timing for delays. Non-POSIX. May be negated.
ofdel	Use delete characters for fill instead of null characters. Non-POSIX. May be negated.
nl1, nl0	Newline delay style. Non-POSIX.
cr3, cr2, cr1, cr0	Carriage return delay style. Non-POSIX.
tab3, tab2, tab1, tab0	Horizontal tab delay style. Non-POSIX.
bs1, bs0	Backspace delay style. Non-POSIX.
vt1, vt0	Vertical tab delay style. Non-POSIX.
ff1, ff0	Form feed delay style. Non-POSIX.

Stty Local settings

Name	Description
isig	Enable `interrupt`, `quit`, and `suspend` special characters. May be negated.
icanon	Enable `erase`, `kill`, `werase`, and `rprnt` special characters. May be negated.
iexten	Enable non-POSIX special characters. May be negated.
echo	Echo input characters. May be negated.
echoe, crterase	Echo `erase` characters as backspace-space-backspace. May be negated.
echok	Echo a newline after a `kill` character. May be negated.
echonl	Echo newline even if not echoing other characters. May be negated.
noflsh	Disable flushing after `interrupt` and `quit` special characters. May be negated.
xcase	Enable input and output of uppercase characters by preceding their lowercase equivalents with `\`, when `icanon` is set. Non-POSIX. May be negated.
tostop	Stop background jobs that try to write to the terminal. Non-POSIX. May be negated.
echoprt, prterase	Echo erased characters backward, between `\` and `/`. Non-POSIX. May be negated.
echoctl, ctlecho	Echo control characters in hat notation (`^C`) instead of literally. Non-POSIX. May be negated.
echoke, crtkill	Echo the `kill` special character by erasing each character on the line as indicated by the `echoprt` and `echoe` settings, instead of by the `echoctl` and `echok` settings. Non-POSIX. May be negated.

Stty Combination settings

Name	Description
evenp, parity	Same as `parenb -parodd cs7`. May be negated. If negated, same as `-parenb cs8`.
oddp	Same as `parenb parodd cs7`. May be negated. If negated, same as `-parenb cs8`.
nl	Same as `-icrnl -onlcr`. May be negated. If negated, same as `icrnl -inlcr -igncr onlcr -ocrnl -onlret`.
ek	Reset the `erase` and `kill` special characters to their default values.
sane	Sets all special characters to their default values and: cread -ignbrk brkint -inlcr -igncr icrnl -ixoff -iuclc -ixany imaxbel opost -olcuc -ocrnl onlcr -onocr -onlret -ofill -ofdel nl0 cr0 tab0 bs0 vt0 ff0 isig icanon iexten echo echoe echok -echonl -noflsh -xcase -tostop -echoprt echoctl echoke
cooked	Same as `brkint ignpar istrip icrnl ixon opost isig icanon`, plus sets the `eof` and `eol` characters to their default values if they are the same as the `min` and `time` characters. May be negated. If negated, same as `raw`.
raw	Same as: -ignbrk -brkint -ignpar -parmrk -inpck -istrip -inlcr -igncr -icrnl -ixon -ixoff -iuclc -ixany -imaxbel -opost -isig -icanon -xcase min 1 time 0 May be negated. If negated, same as `cooked`.
cbreak	Same as `-icanon`. May be negated. If negated, same as `icanon`.
pass8	Same as `-parenb -istrip cs8`. May be negated. If negated, same as `parenb istrip cs7`.
litout	Same as `-parenb -istrip -opost cs8`. May be negated. If negated, same as `parenb istrip opost cs7`.
decctlq	Same as `-ixany`. Non-POSIX. May be negated.
tabs	Same as `tab0`. Non-POSIX. May be negated. If negated, same as `tab3`.
lcase, LCASE	Same as `xcase iuclc olcuc`. Non-POSIX. May be negated.
crt	Same as `echoe echoctl echoke`.
dec	Same as `echoe echoctl echoke -ixany intr ^C erase ^? kill C-u`.

Special characters

The special characters' default values vary from system to system. They are set with the syntax name value, where the names are listed below and the value can be given either literally, in hat notation (^C), or as an integer which may start with 0x to indicate hexadecimal, 0 to indicate octal, or any other digit to indicate decimal.

For GNU stty, giving a value of ^- or undef disables that special character. (This is incompatible with Ultrix stty, which uses a value of u to disable a special character. GNU stty treats a value u like any other, namely to set that special character to .)

Name	Description
`intr`	Send an interrupt signal.
`quit`	Send a quit signal.
`erase`	Erase the last character typed.
`kill`	Erase the current line.
`eof`	Send an end of file (terminate the input).
`eol`	End the line.
`eol2`	Alternate character to end the line. Non-POSIX.
`swtch`	Switch to a different shell layer. Non-POSIX.
`start`	Restart the output after stopping it.
`stop`	Stop the output.
`susp`	Send a terminal stop signal.
`dsusp`	Send a terminal stop signal after flushing the input. Non-POSIX.
`rprnt`	Redraw the current line. Non-POSIX.
`werase`	Erase the last word typed. Non-POSIX.
`lnext`	Enter the next character typed literally, even if it is a special character. Non-POSIX.

Special settings

min N - Set the minimum number of characters that will satisfy a read until the time value has expired, when -icanon is set.
time N - Set the number of tenths of a second before reads time out if the minimum number of characters have not been read, when -icanon is set.
ispeed N - Set the input speed to N.
ospeed N - Set the output speed to N.
rows N - Tell the tty kernel driver that the terminal has N rows. Non-POSIX.
cols N, columns N - Tell the kernel that the terminal has N columns. Non-POSIX.
size - Print the number of rows and columns that the kernel thinks the terminal has. (Systems that don't support rows and columns in the kernel typically use the environment variables LINES and COLUMNS instead; however, GNU stty does not know anything about them.) Non-POSIX.
line N - Use line discipline N. Non-POSIX.
speed - Print the terminal speed.
N - Set the input and output speeds to N. N can be one of: 0 50 75 110 134 134.5 150 200 300 600 1200 1800 2400 4800 9600 19200 38400 exta extb. exta is the same as 19200; extb is the same as 38400. 0 hangs up the line if -clocal is set.

Color Terminals

color256 ()
{
    local L=$(sed 's/[0-9]//g; s/./#/g' <<<`seq -s+0 $(($COLUMNS - 10))`);
    for i in `seq 0 $(tput colors)`;
    do printf " %.3d `tput setab $i`${L}${R} %.3d `tput setab 0;tput setaf 7`\n" $i $i | tr '#' ' ';
    done
}

for F in `find ~/.terminfo/ -type f | sed 's/^.*\///' | xargs -P0 -I'TT' sh -c 'echo "$(tput -T TT colors): TT"'|sed '/^-/d'| grep ^16:|cut -d: -f2`; do
echo -e "\n\n";
pm $F; export TERM=$F; tput -T $F initc; color256; done

find ~/.terminfo/ -type f | sed 's/^.*\///' | xargs -I'TT' sh -c 'echo "$(tput -T TT colors): TT"'|sed '/^-/d'

Terminals with 16 Colors

aixterm-16color
amiga-vnc
hp2397
hp2397a
hp+color
ibm+16color
konsole-16color
nsterm-16color
nsterm-7-c
nsterm-7-c-s
nsterm-acs-c
nsterm-acs-c-s
nsterm-c
nsterm+c
nsterm-c-7
nsterm-c-acs
nsterm-c-s
nsterm-c-s-7
nsterm-c-s-acs
rxvt-16color
screen-16color
screen-16color-bce
screen-16color-bce-s
screen-16color-s
xterm-16color

Terminals with 52 Colors

d430c-dg-ccc
d430c-unix-25-ccc
d430c-unix-ccc
d430c-unix-s-ccc
d430c-unix-sr-ccc
d430c-unix-w-ccc
d430-dg-ccc
d430-unix-25-ccc
d430-unix-ccc
d430-unix-s-ccc
d430-unix-sr-ccc
d430-unix-w-ccc
dg+ccc
dgunix+ccc

Terminals with 64 Colors

hpterm-color
wy370
wy370-101k
wy370-105k
wy370-EPC
wy370-nk
wy370-rv
wy370-vb
wy370-w
wy370-wvb
wyse370
Eterm-88color
rxvt-88color
xterm-88color
xterm+88color

Terminals with 256 colors

Eterm-256color
gnome-256color
konsole-256color
putty-256color
rxvt-256color
screen-256color
screen-256color-bce
screen-256color-bce-s
screen-256color-s
xterm-256color
xterm+256color

View All tput capabilities

http://blogs.msdn.com/adioltean/articles/271063.aspx

function tputs(){ infocmp -1|sed 's/^[   ]*//; /=/!d; s/=.*//g; /[#\|]/d'; }

Some common terminfo parameter sequences, their termcap equivalents, and some terminal types which commonly have such sequences, are:

terminfo                    termcap   Representative Terminals
---------------------------------------------------------------
%p1%c                       %.        adm
%p1%d                       %d        hp, ANSI standard, vt100
%p1%+%c                 %+x       concept
%i                          %iq       ANSI standard, vt100
%p1%?%>%t%p1%+%;    %>xy      concept
%p2 is printed before %p1   %r        hp

Installing your Own Terminfo

MostLike, or if that is offline I uploaded a copy: mostlike - manpages with color looking like most

rm -rvf ~/.terminfo
mkdir -pv ~/.terminfo
curl -o terminfo.master http://nion.modprobe.de/mostlike.txt; curl -Ss ftp://invisible-island.net/ncurses/terminfo.src.gz
export TERMINFO=~/.terminfo;
sudo tic -e screen-256color,screen-256color-s,screen-256color-bce,screen-256color-bce-s,xterm+256color,xterm,xterm-pcolor terminfo.src

256 Colors in Terminal

256 Colors (Background)

W=`tput setaf 7` RC="\E[0;0;0m" L=$(sed 's/[0-9]//g; s/./ /g' <<<`seq -s+0 $(($COLUMNS/2))`);
 
for i in `seq 0 256`;
do
  printf "${W}\n%.3d `tput setab $i`${L}${RC}" $i;
done

256 Colors (Foreground)

W=`tput setaf 7` WB=`tput setab 0` RC="\E[0;0;0m" L=$(sed 's/[0-9]//g; s/./#/g' <<<`seq -s+0 $(($COLUMNS/2))`);
for i in `seq 0 256`;
do
  printf "${WB}\n%.3d `tput setaf $i`${L}${RC}" $i;
done

Terminal Capabilities - Infocmp

infocmp -1Lq|grep -v "$TERM\|#"|tr -d '  '

DEC/ANSI special sequences

List of the DEC/ANSI special sequences recognized:

----------------------------------------- ----------------------------------------- ----------------------------------------- ----------------------------------------- ----------------------------------------- -----------------------------------------

Action	Meaning
`%%`	The percent sign
`%t`	The time the request was received in Universal Coordinated Time since the epoch (Jan. 1, 1970) measured in microseconds. The value is preceded by `t=`.
`%D`	The time from when the request was received to the time the headers are sent on the wire. This is a measure of the duration of the request. The value is preceded by `D=`. The value is measured in microseconds.
`%{VARNAME}e`	The contents of the environment variable `VARNAME`.
`%{VARNAME}s`	The contents of the SSL environment variable `VARNAME`, if `mod_ssl` is enabled.
`RIS`	full reset
`SC`	save cursor
`RC`	restore cursor
`LL`	home-down
`RSR`	reset scroll region
`DECSTR`	soft reset (VT320)
`S7C1T`	7-bit controls (VT220)
`ISO DEC G0`	enable DEC graphics for G0
`ISO UK G0`	enable UK chars for G0
`ISO US G0`	enable US chars for G0
`ISO DEC G1`	enable DEC graphics for G1
`ISO UK G1`	enable UK chars for G1
`ISO US G1`	enable US chars for G1
`DECPAM`	application keypad mode
`DECPNM`	normal keypad mode
`DECANSI`	enter ANSI mode
`ECMA[+-]AM`	keyboard action mode
`ECMA[+-]IRM`	insert replace mode
`ECMA[+-]SRM`	send receive mode
`ECMA[+-]LNM`	linefeed mode
`DEC[+-]CKM`	application cursor keys
`DEC[+-]ANM`	set VT52 mode
`DEC[+-]COLM`	132-column mode
`DEC[+-]SCLM`	smooth scroll
`DEC[+-]SCNM`	reverse video mode
`DEC[+-]OM`	origin mode
`DEC[+-]AWM`	wraparound mode
`DEC[+-]ARM`	auto-repeat mode

Name	Description
acs_chars	``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{\|\|}}~~,
back_tab	`\E[Z,`
bell	`^G,`
carriage_return	`^M,`
change_scroll_region	`\E[%i%p1%d;%p2%dr,`
clear_all_tabs	`\E[3g,`
clear_screen	`\E[H\E[2J,`
clr_bol	`\E[1K,`
clr_eol	`\E[K,`
clr_eos	`\E[J,`
column_address	`\E[%i%p1%dG,`
cursor_address	`\E[%i%p1%d;%p2%dH,`
cursor_down	`^J,`
cursor_home	`\E[H,`
cursor_invisible	`\E[?25l,`
cursor_left	`^H,`
cursor_normal	`\E[?12l\E[?25h,`
cursor_right	`\E[C,`
cursor_up	`\E[A,`
cursor_visible	`\E[?12;25h,`
delete_character	`\E[P,`
delete_line	`\E[M,`
enter_alt_charset_mode	`\E(0,`
enter_am_mode	`\E[?7h,`
enter_blink_mode	`\E[5m,`
enter_bold_mode	`\E[1m,`
enter_ca_mode	`\E[?1049h,`
enter_insert_mode	`\E[4h,`
enter_reverse_mode	`\E[7m,`
enter_secure_mode	`\E[8m,`
enter_standout_mode	`\E[7m,`
enter_underline_mode	`\E[4m,`
erase_chars	`\E[%p1%dX,`
exit_alt_charset_mode	`\E(B,`
exit_am_mode	`\E[?7l,`
exit_attribute_mode	`\E(B\E[m,`
exit_ca_mode	`\E[?1049l,`
exit_insert_mode	`\E[4l,`
exit_standout_mode	`\E[27m,`
exit_underline_mode	`\E[24m,`
flash_screen	`\E[?5h$<100/>\E[?5l,`
init_2string	`\E[\041p\E[?3;4l\E[4l\E>,`
initialize_color	`\E]4;%p1%d;rgb\072%p2%{255}%%{1000}%/%2.2X/%p3%{255}%%{1000}%/%2.2X/%p4%{255}%*%{1000}%/%2.2X\E\,`
insert_line	`\E[L,`
key_b2	`\EOE,`
key_backspace	`\177,`
key_btab	`\E[Z,`
key_dc	`\E[3~,`
key_down	`\EOB,`
key_end	`\EOF,`
key_enter	`\EOM,`
key_f1	`\EOP,`
key_f10	`\E[21~,`
key_f11	`\E[23~,`
key_f12	`\E[24~,`
key_f13	`\EO2P,`
key_f14	`\EO2Q,`
key_f15	`\EO2R,`
key_f16	`\EO2S,`
key_f17	`\E[15;2~,`
key_f18	`\E[17;2~,`
key_f19	`\E[18;2~,`
key_f2	`\EOQ,`
key_f20	`\E[19;2~,`
key_f21	`\E[20;2~,`
key_f22	`\E[21;2~,`
key_f23	`\E[23;2~,`
key_f24	`\E[24;2~,`
key_f25	`\EO5P,`
key_f26	`\EO5Q,`
key_f27	`\EO5R,`
key_f28	`\EO5S,`
key_f29	`\E[15;5~,`
key_f3	`\EOR,`
key_f30	`\E[17;5~,`
key_f31	`\E[18;5~,`
key_f32	`\E[19;5~,`
key_f33	`\E[20;5~,`
key_f34	`\E[21;5~,`
key_f35	`\E[23;5~,`
key_f36	`\E[24;5~,`
key_f37	`\EO6P,`
key_f38	`\EO6Q,`
key_f39	`\EO6R,`
key_f4	`\EOS,`
key_f40	`\EO6S,`
key_f41	`\E[15;6~,`
key_f42	`\E[17;6~,`
key_f43	`\E[18;6~,`
key_f44	`\E[19;6~,`
key_f45	`\E[20;6~,`
key_f46	`\E[21;6~,`
key_f47	`\E[23;6~,`
key_f48	`\E[24;6~,`
key_f49	`\EO3P,`
key_f5	`\E[15~,`
key_f50	`\EO3Q,`
key_f51	`\EO3R,`
key_f52	`\EO3S,`
key_f53	`\E[15;3~,`
key_f54	`\E[17;3~,`
key_f55	`\E[18;3~,`
key_f56	`\E[19;3~,`
key_f57	`\E[20;3~,`
key_f58	`\E[21;3~,`
key_f59	`\E[23;3~,`
key_f6	`\E[17~,`
key_f60	`\E[24;3~,`
key_f61	`\EO4P,`
key_f62	`\EO4Q,`
key_f63	`\EO4R,`
key_f7	`\E[18~,`
key_f8	`\E[19~,`
key_f9	`\E[20~,`
key_home	`\EOH,`
key_ic	`\E[2~,`
key_left	`\EOD,`
key_mouse	`\E[M,`
key_npage	`\E[6~,`
key_ppage	`\E[5~,`
key_right	`\EOC,`
key_sdc	`\E[3;2~,`
key_send	`\E[1;2F,`
key_sf	`\E[1;2B,`
key_shome	`\E[1;2H,`
key_sic	`\E[2;2~,`
key_sleft	`\E[1;2D,`
key_snext	`\E[6;2~,`
key_sprevious	`\E[5;2~,`
key_sr	`\E[1;2A,`
key_sright	`\E[1;2C,`
key_up	`\EOA,`
keypad_local	`\E[?1l\E>,`
\E[?1h\E	`,`
memory_lock	`\El,`
memory_unlock	`\Em,`
orig_pair	`\E[39;49m,`
parm_dch	`\E[%p1%dP,`
parm_delete_line	`\E[%p1%dM,`
parm_down_cursor	`\E[%p1%dB,`
parm_ich	`\E[%p1%d@,`
parm_index	`\E[%p1%dS,`
parm_insert_line	`\E[%p1%dL,`
parm_left_cursor	`\E[%p1%dD,`
parm_right_cursor	`\E[%p1%dC,`
parm_rindex	`\E[%p1%dT,`
parm_up_cursor	`\E[%p1%dA,`
print_screen	`\E[i,`
prtr_off	`\E[4i,`
prtr_on	`\E[5i,`
reset_1string	`\Ec,`
reset_2string	`\E[\041p\E[?3;4l\E[4l\E>,`
restore_cursor	`\E8,`
row_address	`\E[%i%p1%dd,`
save_cursor	`\E7,`
scroll_forward	`^J,`
scroll_reverse	`\EM,`
set_a_background	`\E[%?%p1%{8}%`

Term Sorted

./MKtermsort.sh |sed 's/.*\/\*  \(.*\)  \*\//\1/g'|sort -u|grep ^[a-zA-Z]|sortwc|grep -v ^static|sort -d|tr " " ','|sed 's/\([^,]\{1,\}\),/\1<\/var>,/g'

AB,ac,acs_btee,acsc,acs_chars,acs_hline,acs_llcorner,acs_lrcorner,acs_ltee,acs_plus,acs_rtee,acs_ttee,acs_ulcorner,acs_urcorner,acs_vline,ae,AF,al,AL,alt_scancode_esc,am,apstr,arrow_key_map,as,auto_left_margin,auto_right_margin,back_color_erase,backspace_delay,backspace_if_not_bs,backspaces_with_bs,back_tab,batt1,batt2,bc,bce,bel,bell,bicr,binel,birep,bit_image_carriage_return,bit_image_entwining,bit_image_newline,bit_image_repeat,bit_image_type,bitwin,bitype,bl,blink,bold,box1,box2,box_chars_1,bs,bt,BT,btml,btns,buffer_capacity,bufsz,buttons,bw,bx,can_change,carriage_return,carriage_return_delay,cb,cbt,cc,CC,ccc,cd,ce,ceol_standout_glitch,ch,change_char_pitch,change_line_pitch,change_res_horz,change_res_vert,change_scroll_region,char_padding,char_set_names,chr,chts,ci,civis,cl,clear,clear_all_tabs,clear_margins,clear_screen,clr_bol,clr_eol,clr_eos,cm,CM,cmdch,cnorm,co,Co,code_set_init,col_addr_glitch,colb0,colb1,colb2,colb3,colb4,colb5,colb6,colb7,colf0,colf1,colf2,colf3,colf4,colf5,colf6,colf7,color_names,colornm,colors,cols,column_address,columns,command_character,cpi,cpi_changes_res,cpix,cps,cr,cr_cancels_micro_mode,create_window,crt_no_scrolling,crxm,cs,csin,csnm,csr,ct,cub,cub1,cud,cud1,cuf,cuf1,cup,cursor_address,cursor_down,cursor_home,cursor_invisible,cursor_left,cursor_mem_address,cursor_normal,cursor_right,cursor_to_ll,cursor_up,cursor_visible,cuu,cuu1,cv,cvr,cvvis,CW,cwin,da,daisy,db,dB,dc,dC,DC,dch,dch1,dclk,defbi,defc,define_bit_image_region,define_char,delete_character,delete_line,dest_tabs_magic_smso,device_type,devt,DI,dial,dial_phone,dim,dispc,display_clock,display_pc_char,dis_status_line,DK,dl,DL,dl1,dm,dN,do,DO,docr,dot_horz_spacing,dot_vert_spacing,down_half_line,ds,dsl,dT,dv,eA,eat_newline_glitch,ec,ech,ed,ehhlm,ei,el,el1,elhlm,elohlm,ena_acs,enacs,endbi,end_bit_image_region,enter_alt_charset_mode,enter_am_mode,enter_blink_mode,enter_bold_mode,enter_ca_mode,enter_delete_mode,enter_dim_mode,enter_doublewide_mode,enter_draft_quality,enter_horizontal_hl_mode,enter_insert_mode,enter_italics_mode,enter_left_hl_mode,enter_leftward_mode,enter_low_hl_mode,enter_micro_mode,enter_near_letter_quality,enter_normal_quality,enter_pc_charset_mode,enter_protected_mode,enter_reverse_mode,enter_right_hl_mode,enter_scancode_mode,enter_secure_mode,enter_shadow_mode,enter_standout_mode,enter_subscript_mode,enter_superscript_mode,enter_top_hl_mode,enter_underline_mode,enter_upward_mode,enter_vertical_hl_mode,enter_xon_mode,eo,erase_chars,erase_overstrike,erhlm,es,eslok,ethlm,evhlm,exit_alt_charset_mode,exit_am_mode,exit_attribute_mode,exit_ca_mode,exit_delete_mode,exit_doublewide_mode,exit_insert_mode,exit_italics_mode,exit_leftward_mode,exit_micro_mode,exit_pc_charset_mode,exit_scancode_mode,exit_shadow_mode,exit_standout_mode,exit_subscript_mode,exit_superscript_mode,exit_underline_mode,exit_upward_mode,exit_xon_mode,F1,F2,F3,F4,F5,F6,F7,F8,F9,Fa,FA,Fb,FB,Fc,FC,Fd,FD,Fe,FE,ff,Ff,FF,Fg,FG,fh,Fh,FH,Fi,FI,fixed_pause,Fj,FJ,Fk,FK,Fl,FL,flash,flash_hook,flash_screen,fln,Fm,FM,Fn,FN,Fo,FO,font0,font1,font2,font3,font4,font5,font6,font7,form_feed,Fp,FP,Fq,FQ,Fr,FR,from_status_line,fs,FS,fsl,FT,FU,FV,FW,FX,FY,FZ,G1,G2,G3,G4,GC,GD,generic_type,getm,get_mouse,GH,GL,Gm,gn,gnu_has_meta_key,goto_window,GR,GU,GV,hangup,hard_copy,hard_cursor,has_hardware_tabs,has_meta_key,has_print_wheel,has_status_line,hc,HC,hd,hl,hls,ho,home,hook,horizontal_tab_delay,hpa,hs,ht,hts,hu,HU,hue_lightness_saturation,hup,hz,i1,i2,i3,ic,Ic,IC,ich,ich1,if,il,il1,im,in,ind,indn,init_1string,init_2string,init_3string,initc,init_file,initialize_color,initial ize_pair,initp,init_prog,init_tabs,insert_character,insert_line,insert_null_glitch,insert_padding,invis,ip,iP,Ip,iprog,is,is1,is2,is3,it,k;,k0,k1,K1,k2,K2,k3,K3,k4,K4,k5,K5,k6,k7,k8,k9,ka,kA,ka1,ka3,kact,kb,kB,kb2,kbeg,kBEG,kbs,kbtab,kC,kc1,kc3,kcan,kCAN,kcbt,kclo,kclr,kcmd,kCMD,kcpn,kcpy,kCPY,kcrt,kCRT,kctab,kcub1,kcud1,kcuf1,kcuu1,kd,kD,kDC,kdch1,kDL,kdl1,kdo,ke,kE,ked,kel,kend,kEND,kent,kEOL,kext,kEXT,key_a1,key_a3,key_b2,key_backspace,key_beg,key_btab,key_c1,key_c3,key_cancel,key_catab,key_clear,key_close,key_command,key_copy,key_create,key_ctab,key_dc,key_dl,key_down,key_eic,key_end,key_enter,key_eol,key_eos,key_exit,key_f0,key_f1,key_f10,key_f11,key_f12,key_f13,key_f14,key_f15,key_f16,key_f17,key_f18,key_f19,key_f2,key_f20,key_f21,key_f22,key_f23,key_f24,key_f25,key_f26,key_f27,key_f28,key_f29,key_f3,key_f30,key_f31,key_f32,key_f33,key_f34,key_f35,key_f36,key_f37,key_f38,key_f39,key_f4,key_f40,key_f41,key_f42,key_f43,key_f44,key_f45,key_f46,key_f47,key_f48,key_f49,key_f5,key_f50,key_f51,key_f52,key_f53,key_f54,key_f55,key_f56,key_f57,key_f58,key_f59,key_f6,key_f60,key_f61,key_f62,key_f63,key_f7,key_f8,key_f9,key_find,key_help,key_home,key_ic,key_il,key_left,key_ll,key_mark,key_message,key_mouse,key_move,key_next,key_npage,key_open,key_options,keypad_local,keypad_xmit,key_ppage,key_previous,key_print,key_redo,key_reference,key_refresh,key_replace,key_restart,key_resume,key_right,key_save,key_sbeg,key_scancel,key_scommand,key_scopy,key_screate,key_sdc,key_sdl,key_select,key_send,key_seol,key_sexit,key_sf,key_sfind,key_shelp,key_shome,key_sic,key_sleft,key_smessage,key_smove,key_snext,key_soptions,key_sprevious,key_sprint,key_sr,key_sredo,key_sreplace,key_sright,key_srsume,key_ssave,key_ssuspend,key_stab,key_sundo,key_suspend,key_undo,key_up,kF,kf0,kf1,kf10,kf11,kf12,kf13,kf14,kf15,kf16,kf17,kf18,kf19,kf2,kf20,kf21,kf22,kf23,kf24,kf25,kf26,kf27,kf28,kf29,kf3,kf30,kf31,kf32,kf33,kf34,kf35,kf36,kf37,kf38,kf39,kf4,kf40,kf41,kf42,kf43,kf44,kf45,kf46,kf47,kf48,kf49,kf5,kf50,kf51,kf52,kf53,kf54,kf55,kf56,kf57,kf58,kf59,kf6,kf60,kf61,kf62,kf63,kf7,kf8,kf9,kfnd,kFND,kh,kH,khlp,kHLP,kHOM,khome,khts,kI,kIC,kich1,kil1,kind,kl,kL,kLFT,kll,km,kM,Km,kmous,kmov,kMOV,kmpf1,kmpf2,kmpf3,kmpf4,kmpf5,kmpf6,kmpf7,kmpf8,kmpf9,kmpt1,kmpt2,kmpt3,kmpt4,kmpt5,kmpt6,kmpt7,kmpt8,kmpt9,kmrk,kmsg,kMSG,kn,kN,knl,knp,knpn,knxt,kNXT,ko,kopn,kopt,kOPT,kP,kpp,kppn,kprt,kPRT,kprv,kPRV,kquit,kr,kR,krdo,kRDO,kref,kres,kRES,krfr,kri,kRIT,krmir,krpl,kRPL,krst,ks,kS,ksav,kSAV,kscl,kscr,ksel,ksf1,ksf10,ksf2,ksf3,ksf4,ksf5,ksf6,ksf7,ksf8,ksf9,kslt,kspd,kSPD,kt,kT,ktab,ktbc,ku,kund,kUND,l0,l1,l2,l3,l4,l5,l6,l7,l8,l9,la,label_format,label_height,label_off,label_on,label_width,lab_f0,lab_f1,lab_f10,lab_f2,lab_f3,lab_f4,lab_f5,lab_f6,lab_f7,lab_f8,lab_f9,le,LE,Lf,LF,lf0,lf1,lf10,lf2,lf3,lf4,lf5,lf6,lf7,lf8,lf9,lh,li,linefeed_if_not_lf,linefeed_is_newline,lines,lines_of_memory,ll,lm,LO,lpi,lpi_changes_res,lpix,lvert,lw,ma,maddr,magic_cookie_glitch,magic_cookie_glitch_ul,max_attributes,max_colors,maximum_windows,max_micro_address,max_micro_jump,max_pairs,mb,MC,mc0,mc4,mc5,mc5i,mc5p,mcs,mcub,mcub1,mcud,mcud1,mcuf,mcuf1,mcuu,mcuu1,md,me,meml,memory_above,memory_below,memory_lock,memory_unlock,memu,meta_off,meta_on,mgc,mh,mhpa,mi,Mi,micro_col_size,micro_column_address,micro_down,micro_left,micro_line_size,micro_right,micro_row_address,micro_up,minfo,mir,mjump,mk,ml,ML,mls,mm,mo,mouse_info,move_insert_mode,move_standout_mode,mp,mr,MR,mrcup,ms,msgr,MT,mu,mvpa,MW,nc,NC,ncv,nd,ND,ndscr,needs_xon_xoff,nel,newline,new_line_delay,nl,Nl,NL,nlab,no_color_video,no_correctly_working_cr,no_esc_ctlc,non_dest_scroll_region,non_rev_rmcup,no_pad_char,NP,npc,npins,NR,nrrmc,ns,number_of_function_keys,number_of_pins,num_labels,nw,nx,nxon,oc,op,orc,order_of_pins,orhi,orig_colors,orig_pair,orl,orvi,os,OTbc,OTbs,OTdB,OTdC,OTdN,OTdT,OTG1,OTG2,OTG3,OTG4,OTGC,OTGD,OTGH,OTGL,OTGR,OTGU,OTGV,other_non_function_keys,OTi2,OTkn,OTko,OTma,OTMT,OTnc,OTnl,OTNL,OTns,OTpt,OTrs,OTug,OTxr,output_res_char,output_res_horz_inch,output_res_line,output_res_vert_inch,over_strike,pa,PA,pad,pad_char,padding_baud_rate,pairs,parm_dch,parm_delete_line,parm_down_cursor,parm_down_micro,parm_ich,parm_index,parm_insert_line,parm_left_cursor,parm_left_micro,parm_right_cursor,parm_right_micro,parm_rindex,parm_up_cursor,parm_up_micro,pause,pb,pc,pc_term_options,pctrm,pf,pfkey,pfloc,pfx,pfxl,pk,pkey_key,pkey_local,pkey_plab,pkey_xmit,pl,plab_norm,pln,pn,po,pO,porder,print_rate,print_screen,prot,prtr_non,prtr_off,prtr_on,prtr_silent,ps,pt,PU,pulse,px,QD,qdial,quick_dial,r1,r2,r3,RA,rbim,rc,RC,rcsd,remove_clock,rep,repeat_char,req_for_input,req_mouse_pos,reqmp,reset_1string,reset_2string,reset_3string,reset_file,restore_cursor,return_does_clr_eol,rev,rf,RF,rfi,ri,RI,rin,ritm,rlm,rmacs,rmam,rmclk,rmcup,rmdc,rmicm,rmir,rmkx,rmln,rmm,rmp,rmpch,rmsc,rmso,rmul,rmxon,row_address,row_addr_glitch,rp,rP,RQ,rs,rs1,rs2,rs3,rshm,rsubm,rsupm,rum,rvert,rwidm,RX,s0,s0ds,s1,S1,s1ds,s2,S2,s2ds,s3,S3,s3ds,S4,S5,S6,S7,S8,sa,sA,SA,sam,save_cursor,Sb,sbim,sc,SC,scancode_escape,scesa,scesc,sclk,scp,scroll_forward,scroll_reverse,scs,scsd,sdrfq,se,select_char_set,semi_auto_right_margin,set0_des_seq,set1_des_seq,set2_des_seq,set3_des_seq,set_a_attributes,setab,set_a_background,setaf,set_a_foreground,set_attributes,setb,set_background,set_bottom_margin,set_bottom_margin_parm,set_clock,setcolor,set_color_band,set_color_pair,setf,set_foreground,set_left_margin,set_left_margin_parm,set_lr_margin,set_page_length,set_pglen_inch,set_right_margin,set_right_margin_parm,set_tab,set_tb_margin,set_top_margin,set_top_margin_parm,set_window,sf,Sf,SF,sg,sgr,sgr0,sgr1,sitm,sL,slength,slines,slm,smacs,smam,smcup,smdc,smgb,smgbp,smgl,smglp,smglr,smgr,smgrp,smgt,smgtb,smgtp,smicm,smir,smkx,smln,smm,smpch,smsc,smso,smul,smxon,snlq,snrmq,so,sp,spinh,spinv,sr,SR,sshm,ssubm,ssupm,st,start_bit_image,start_char_set_def,status_line_esc_ok,stop_bit_image,stop_char_set_def,subcs,subscript_characters,sum,supcs,superscript_characters,swidm,SX,ta,tab,tbc,te,termcap_init2,termcap_reset,these_cause_cr,ti,tilde_glitch,TO,tone,topl,to_status_line,transparent_underline,ts,tsl,u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,uc,ue,ug,ul,underline_char,up,UP,up_half_line,us,user0,user1,user2,user3,user4,user5,user6,user7,user8,user9,ut,vb,ve,vi,virtual_terminal,vpa,vs,vt,WA,wait,wait_tone,WG,wi,widcs,wide_char_size,width_status_line,wind,wingo,wnum,ws,wsl,xb,xenl,XF,Xh,xhp,xhpa,xl,Xl,xmc,xn,XN,xo,Xo,xoffc,xoff_character,xon,xonc,xon_character,xon_xoff,xr,Xr,xs,xsb,xt,Xt,Xv,xvpa,Xy,Ya,YA,Yb,YB,Yc,YC,Yd,YD,Ye,YE,Yf,YF,Yg,YG,Yh,Yi,Yj,Yk,Yl,Ym,Yn,Yo,Yp,Yv,Yw,Yx,Yy,Yz,YZ,Za,ZA,Zb,ZB,Zc,ZC,Zd,ZD,Ze,ZE,zerom,zero_motion,Zf,ZF,Zg,ZG,Zh,ZH,Zi,ZI,Zj,ZJ,Zk,ZK,Zl,ZL,Zm,ZM,Zn,ZN,Zo,ZO,Zp,ZP,Zq,ZQ,Zr,ZR,Zs,ZS,Zt,ZT,Zu,ZU,Zv,ZV,Zw,ZW,Zx,ZX,Zy,ZY,Zz,ZZ

TERMINAL TYPE DESCRIPTIONS SOURCE FILE

ANSI, UNIX CONSOLE, AND SPECIAL TYPES
Specials
ANSI.SYS/ISO 6429/ECMA-48 Capabilities
ANSI/ECMA-48 terminals and terminal emulators
DOS ANSI.SYS variants
ANSI console types
BeOS
Linux consoles
Mach
OSF Unix
QNX
NetBSD consoles
FreeBSD console entries
386BSD and BSD/OS Consoles
DEC VT52
DEC VT100 and compatibles
VT100 emulations
X terminal emulators
MGR
UNIX VIRTUAL TERMINALS, VIRTUAL CONSOLES, AND TELNET CLIENTS
Pilot Pro Palm-Top
COMMERCIAL WORKSTATION CONSOLES
Alpha consoles
Sun consoles
Iris consoles
NeWS consoles
NeXT consoles
Sony NEWS workstations
Common Desktop Environment
Non-Unix Consoles
COMMON TERMINAL TYPES
Altos
Hewlett-Packard (hp)
Honeywell-Bull
Lear-Siegler (adm)
Prime
Qume (qvt)
Televideo (tvi)
Visual (vi)
Wyse (wy)
Kermit terminal emulations
NON-ANSI TERMINAL EMULATIONS
Avatar
RBcomm
LCD DISPLAYS
Matrix Orbital
OLDER TERMINAL TYPES
AT&T (att, tty)
Ampex (Dialogue)
Ann Arbor (aa)
Applied Digital Data Systems (adds)
C. Itoh Electronics
Control Data (cdc)
Getronics
Human Designed Systems (Concept)
Contel Business Systems.
Data General (dg)
Datamedia (dm)
Falco

Just something sorta cool for you to check out

{
 local t=`tputm 'clear' 'setaf 75'` l a b f=/tmp/ps IFS=' ';
exec 6<>$f;ps L|tr -s ' ' &>$f;
while read -u6 l;do a=${l/% */} b=${l/* /};
figlet -rtw $((${COLUMNS} /2 )) -f big "$l";
tput sgr0;
command ps wwo pid:6,user:8,vsize:8,comm:20,$a:50 k -$a -A;cont;
done;
};

Terminal Escape Code Zen originally appeared on AskApache.com

Advanced Linux Debugging using a Bootloader (GRUB)

AskApache — Thu, 07 Apr 2011 16:35:41 +0000

AskApache.com

This is part of the GRUB article on the Arch Linux wiki that I contributed. As of now, just a copy.

The grub menu.lst provides for a convenient way to add a number of entries with extended kernel parameters to configure all sorts of advanced settings to enable you to quickly and conveniently boot into your existing system with varying levels of debugging output. It's very easy and useful to create several levels of debugging just by adding additional entries to your grub configuration. And if you ever have issues or problems down the road due to a power-failure or hardware failure, it can save you hours of trouble, and of course nothing can beat debugging output when it comes to learning about your system.

Useful Menu.lst Entries

If you are interested in debugging, then you deserve some grub entries for powerusers, here are a few that I like (just add to your menu.lst).

title Shutdown the Computer
halt
 
title Reboot the Computer
reboot
 
title Command Line
commandline
 
title Install GRUB to hd0 MBR
root (hd0,0)
setup (hd0)
 
title Matrix
color green/black light-green/green
 
title Scan for /boot/grub/menu.lst
find --set-root --ignore-floppies /boot/grub/menu.lst
configfile /boot/grub/menu.lst
 
title Scan for /boot/menu.lst
find --set-root --ignore-floppies /menu.lst
configfile /boot/menu.lst
 
# http://www.vortex.prodigynet.co.uk/x86test/
title    Run x86test (CPU Info)
kernel /boot/x86test_zImage.bin
#wget http://www.vortex.prodigynet.co.uk/x86test/x86test_zImage.bin
 
# http://www.memtest.org/
title    Run memtest86+ (Memory Testing)
kernel /boot/memtest86+-1.70.bin

Light Debug

A quick way to see more verbose messages on your console is to bootup your normal grub entry after appending verbose to the kernel line. This simple word added to your kernel line turns on more logging thanks to the /etc/rc.sysinit file, which at the top of the file runs:

if /bin/grep -q " verbose" /proc/cmdline; then /bin/dmesg -n 8; fi

Very simple way to get a bit more messages and debug output in your logs.

title  Arch Linux DEBUG Light
kernel /vmlinuz26 root=/dev/disk/by-label/ROOT ro rootwait verbose
initrd /kernel26.img

Medium Debug

This example menu.lst entry turns on real logging that is set by the kernel and not in an init script. Adding the debug kernel parameter to your kernel line is recognized by a lot of linux internals and enables quite a bit of debugging compared to the default.

title Arch Linux DEBUG Medium
kernel /vmlinuz26 root=/dev/disk/by-label/ROOT ro rootdelay=5 panic=10 debug
initrd /kernel26.img

Heavy Debug

An even more impressive kernel parameter is the ignore_loglevel, which causes the system to ignore any loglevel and keeps the internal loglevel at the maximum debugging level, basically rendering dmesg unable to lower the debug level.

title Arch Linux DEBUG Heavy
kernel /vmlinuz26 root=/dev/disk/by-label/ROOT ro rootdelay=5 panic=10 debug ignore_loglevel
initrd /kernel26.img

Extreme Debug

If the "Heavy Debug" seemed like a lot of output, thats about 1/2 of the logging that occurs with this example. This does a couple things, it uses the earlyprintk parameter to setup your kernel for "early" "printing" of messages to your "vga" screen. The ,keep just lets it stay on the screen longer. This will let you see logs that normally are hidden due to the boot-up process. This also changes the log buffer length to 10MB, and also instructs that any fatal signals be printed with print_fatal_signals. The last one, sched_debug, you can look up in the very excellent kernel documentation on kernel parameters.

title Arch Linux DEBUG Extreme
kernel /vmlinuz26 root=/dev/disk/by-label/ROOT ro debug ignore_loglevel log_buf_len=10M print_fatal_signals=1 LOGLEVEL=8 earlyprintk=vga,keep sched_debug
initrd /kernel26.img

Insane Debug

The first few debugging examples showed some really nice kernel parameters to turn on really verbose debugging. This kind of debugging is absolutely critical if you want to max out your system or just learn more about what is going on behind the scenes. But there is a final trick that is my favorite, it's the ability to set both environment variables, and more importantly, module parameters at boot.

As an example, here is the boot line that I am using at the moment on an older Dell Desktop, just to illustrate module parameters and environment vars.

title  Arch Linux X-256
kernel /vmlinuz26 root=/dev/disk/by-label/ROOT ro rootwait pause_on_oops=5 panic=60 i915.modeset=1 no_console_suspend ipv6.disable=1 TERM=xterm-256color quiet 5
initrd /kernel26.img

Since it's low on both memory and CPU, I disable ipv6. I also turn on kernel modesetting for the i915 video card, set my terminal to be xterm-256color, and boot straight into X. This lets me use a very optimized arch-linux configuration, amazing how fast thanks to using slim as the login manager, ratpoison as my window manager, and terminal with tmux as my login shell, all from boot, as the pstree shows (plus Synergy!).

init,1
  |-slim,3096
  |   |-X,3098 -nolisten tcp vt07 -auth /var/run/slim.auth
  |   `-ratpoison,3107,askapache
  |       |-terminal,5341 -x sh -c exec /usr/bin/tmux -2 -l -u -q attach -d -t tmux-askapache
  |       |   |-bash,11165
  |       |   |-tmux,5345 -2 -l -u -q attach -d -t tmux-askapache
  |       |   `-{terminal},5346
  |       `-xscreensaver,3113 -no-splash
  |-synergyc,6121,galileo -f --name galileo-fire --restart 10.66.66.2:26666
  |
  `-tmux,5348,askapache -2 -l -u -q attach -d -t tmux-askapache
      |-bash,5351
      |   `-ssh,9969 lug@askapache.com
      `-bash,5868
         `-vim,11149 -p sda1/grub/menu.lst /boot/grub/menu.lst

That kind of optimized system is only possible if you first can figure out your system, by debugging both the kernel as previously illustrated, debugging the init process, and most importantly, by debugging the modules enabled for your system's hardware/firmware/software. Debugging modules is challenging but worth the effort, and then you are able to do some truly insane debugging from grub like the following example, note that the actual grub entry is all on one line, but I split it into 4 lines so you could see it all. This basically turns on every module on this little Dell desktop to be at the absolute max debug level. There is so much logging when I boot this that the system grinds to a halt and is slower than a TI-89 calculator (See Improve Boot Performance).

title  Arch Linux DEBUG INSANE
kernel /vmlinuz26 root=/dev/disk/by-label/ROOT ro rootwait ignore_loglevel debug debug_locks_verbose=1 sched_debug initcall_debug mminit_loglevel=4 udev.log_priority=8
       loglevel=8 earlyprintk=vga,keep log_buf_len=10M print_fatal_signals=1 apm.debug=Y i8042.debug=Y drm.debug=1 scsi_logging_level=1 usbserial.debug=Y
       option.debug=Y pl2303.debug=Y firewire_ohci.debug=1 hid.debug=1 pci_hotplug.debug=Y pci_hotplug.debug_acpi=Y shpchp.shpchp_debug=Y apic=debug
       show_lapic=all hpet=verbose lmb=debug pause_on_oops=5 panic=10 sysrq_always_enabled
initrd /kernel26.img

A couple key items from that grub entry are sysrq_always_enabled which forces on the sysrq magic, which really is a lifesaver when debugging at this level as your machine will freeze/stop-responding sometimes and it's nice to use sysrq to kill all tasks, change the loglevel, unmount all filesystems, or do a hard reboot. Another key parameter is the initcall_debug, which debugs the init process in excruciating detail. Very useful at times. The last parametery I find very useful is the udev.log_priority=8 to turn on udev logging.

Break Into Init

For instance, If you add break=y to your kernel cmdline, init will pause early in the boot process (after loading modules) and launch an interactive sh shell which can be used for troubleshooting purposes. (Normal boot continues after logout.) This is very similar to the shell that shows up if your computer gets turned off before it is able to shutdown properly. But using this parameter lets you enter into this mode differently at will.

title  Arch Linux Init Break
kernel /vmlinuz26 root=/dev/disk/by-label/ROOT ro rootwait break=y
initrd /kernel26.img

Debugging init

This awesome parameter udev.log_priority=8 does the same thing as editing the file /etc/udev/udev.conf except it executes earlier, turning on debugging output for udev. If you want to know your hardware, that is the key parameter right there. Another trick is if you change the /etc/udev/udev.conf to be verbose, then you can make your initrd image include that file to turn on verbose udeb debugging by adding it to your {{Filename|/etc/mkinitcpio.conf} like:

FILES="/etc/modprobe.d/modprobe.conf /etc/udev/udev.conf"

, which on arch is as easy as

# mkinitcpio -p kernel26

Debugging udev is key because the initrd performs a root change at the end of its run to usually launch a program like /sbin/init as part of a chroot, and unless the new file system has a valid /dev directory, udev must be initialized before invoking chroot in order to provide /dev/console.

exec chroot . /sbin/init dev/console 2>&1

So basically, you aren't able to view the logs that are generated before /dev/console is initialized by udev or by a special initrd you compiled yourself. One method the kernel developers use to be able to still get the log messages generated before /dev/console is available is to provide an alternative console that you can enable or disable from grub.

Net Console

If you read through the kernel documentation regarding debugging, you will hear about Netconsole, which can be loaded from the kernel line in GRUB, compiled into your kernel, or loaded at runtime as a module. Having a netconsole entry in your menu.lst is most excellent for debugging slower computers like old laptops or thin-clients. It's easy to use. Just setup a 2nd computer (running arch) to accept syslog requests on a remote port, very fast and quick to do on arch-linux, 1 line to syslog.conf. Then you could use a log-color-parser like ccze to view all syslog logs, or just tail your everything.log. Then on your laptop, boot up and select the netconsole entry from the grub menu, and you will start seeing as much logging as you want on your syslog system. This logging lets you view even earlier log output than is available with the earlyprintk=vga kernel parameter, as netconsole is used by kernel hackers and developers, so it's very powerful.

title  Arch Linux DEBUG Netconsole
kernel /vmlinuz26 root=/dev/disk/by-label/ROOT ro netconsole=514@10.0.0.2/12:34:56:78:9a:bc debug ignore_loglevel
initrd /kernel26.img

Hijacking cmdline

If you do not have access to GRUB or the kernel boottime cmdline, like on a server or virtual machine, as long as you have root permissions you can still enable this kind of simplistic verbose logging using a neat hack. While you cannot modify the /proc/cmdline even as root, you can place your own cmdline file on top of /proc/cmdline, so that accessing /proc/cmdline actually accesses your file.

For example if I cat /proc/cmdline, I have the following:

root=/dev/disk/by-label/ROOT ro console=tty1 logo.nologo quiet

So I use a simple sed command to replace quiet with verbose like:

sed 's/ quiet/ verbose/' /proc/cmdline > /root/cmdline

Then I bind mount /root/cmdline so that it becomes /proc/cmdline, using the -n option to mount so that this mount won't be recorded in the systems mtab.

mount -n --bind -o ro /root/cmdline /proc/cmdline

Now if I cat /proc/cmdline, I have the following:

root=/dev/disk/by-label/ROOT ro console=tty1 logo.nologo verbose

Advanced Linux Debugging using a Bootloader (GRUB) originally appeared on AskApache.com

Ultimate Htaccess Part II

AskApache — Sat, 16 Oct 2010 16:11:33 +0000

AskApache.com

Here is even more information from the Ultimate Htaccess Part I. For now this is very rough and you will want to come back later to read it.

Merging Notes

The order of merging is:

(except regular expressions) and .htaccess done simultaneously (with .htaccess, if allowed, overriding )
(and )
and done simultaneously
and done simultaneously

Below is an artificial example to show the order of merging. Assuming they all apply to the request, the directives in this example will be applied in the order:

A > B > C > D > E


E


D



B



C


A

Htaccess Software

Apache HTTP Server comes with the following programs.

httpd: Apache hypertext transfer protocol server
apachectl: Apache HTTP server control interface
ab: Apache HTTP server benchmarking tool
apxs: APache eXtenSion tool
dbmmanage: Create and update user authentication files in DBM format for basic authentication
fcgistarter: Start a FastCGI program
htcacheclean: Clean up the disk cache
htdigest: Create and update user authentication files for digest authentication
htdbm: Manipulate DBM password databases.
htpasswd: Create and update user authentication files for basic authentication
httxt2dbm: Create dbm files for use with RewriteMap
logresolve: Resolve hostnames for IP-addresses in Apache logfiles
log_server_status: Periodically log the server's status
rotatelogs: Rotate Apache logs without having to kill the server
split-logfile: Split a multi-vhost logfile into per-host logfiles
suexec: Switch User For Exec

Options All
AuthType "Basic"
AuthName "Protected Access"
 
#SetEnv APPLICATION_ENV production
SetEnv APPLICATION_ENV development
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
 
ErrorDocument 404 /index.php
 
AddType text/html url
 
order allow,deny
allow from all
Options +ExecCGI
 
AddHandler python-program .py
PythonHandler mod_python.publisher
PythonDebug On
PythonAutoReload On
 
RewriteEngine on
RewriteRule .* - [E=HTTP_IF_MODIFIED_SINCE:%{HTTP:If-Modified-Since}]
RewriteRule .* - [E=HTTP_IF_NONE_MATCH:%{HTTP:If-None-Match}]
 
# updating tab.ser takes lots of memory
php_value memory_limit 64000000
 
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
 
php_flag magic_quotes_gpc Off
php_flag magic_quotes_runtime Off
 
# redirect moved files
RedirectMatch Permanent ^/fop/anttask(.*) http://xmlgraphics.apache.org/fop/0.20.5/anttask$1
RedirectMatch Permanent ^/fop/compiling(.*) http://xmlgraphics.apache.org/fop/0.20.5/compiling$1
RedirectMatch Permanent ^/fop/configuration(.*) http://xmlgraphics.apache.org/fop/0.20.5/configuration$1
RedirectMatch Permanent ^/fop/embedding(.*) http://xmlgraphics.apache.org/fop/0.20.5/embedding$1
 

ExpiresActive On
ExpiresDefault "access plus 52 weeks"

 
# $Id: .htaccess 1255 2003-12-21 05:30:57Z rufustfirefly $
# $Author: rufustfirefly $
#
# Since sometimes Apache isn't properly configured to view the
# proper PHP script, we do this instead, but only if PHP4 is
 


Order Allow,Deny
Allow from 127.0.0.1
RewriteEngine On
# map phocoa framework wwwroot - enabled PHOCOA Versioning
RewriteRule ^/www/framework(/[0-9\.]*)?/?(.*) /wwwroot/www/framework/$2 [L]
#enable a normal wwwroot
 
RewriteEngine on
RewriteRule Boot/(.*) Boot/$1 [QSA,L]
 
RewriteEngine on
RewriteRule ^xbl.js build/xbl.php
RewriteRule ^ie-dom.js build/ie-dom.php
 
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php [QSA,L]
 
# Rewrite rules for Zend Framework
RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule (.*) index.php/$1 [L]
 
AuthUserFile /dev/null
AuthGroupFile /dev/null
AuthName "You are not welcomed here"
AuthType Basic

 
AddHandler application/x-httpd-php-source php
 
DirectoryIndex index.html index.php
AddDefaultCharset UTF-8
RewriteEngine off
# Web Optimizer options
 
ErrorDocument 404 /~george/blog/index.php
AddType application/x-httpd-php .php .rdf
 
# redirect moved files
RedirectMatch Permanent ^/fop/anttask(.*) http://xmlgraphics.apache.org/fop/0.20.5/anttask$1
RedirectMatch Permanent ^/fop/compiling(.*) http://xmlgraphics.apache.org/fop/0.20.5/compiling$1
RedirectMatch Permanent ^/fop/configuration(.*) http://xmlgraphics.apache.org/fop/0.20.5/configuration$1
RedirectMatch Permanent ^/fop/embedding(.*) http://xmlgraphics.apache.org/fop/0.20.5/embedding$1
AddHandler x-httpd-php504 .php
AddType application/x-httpd-php .html
 
RewriteEngine on
# Remember to change RewriteBase to where your site really is - for example if
# you access the site by www.somesite.com/~myname/thesite, you do as so:
# RewriteBase /~myname/thesite/
 

Order deny,allow
Deny From All

 
#
# Apache/PHP/Drupal settings:
#
# Protect files and directories from prying eyes.
 
DirectoryIndex membersite.pl
Options +ExecCGI
AddHandler cgi-script .pl
 
#AddType application/x-httpd-php .php3 .phtml .php .php4 .php5 .html .html .xml
Options -Indexes
Options +FollowSymLinks
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
 
# Comment/uncomment the lines below depending of your needs
# To deny any access to this directory
Deny from all
 

RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ index.php/$1 [L]
 

Order allow,deny
Deny from all

 
AddHandler application/x-httpd-php5 .php5 .php4 .php .php3 .php2 .phtml
AddType application/x-httpd-php5 .php5 .php4 .php .php3 .php2 .phtml
AddHandler application/x-httpd-php5 .snow
AddType application/x-httpd-php5 .snow
AddHandler image/jpeg me
Redirect permanent /~hoge/hns-lite/i/ http://www.example.ne.jp/~hoge/hns-lite/
 
# Make index.php the default
DirectoryIndex index.php
Options -Indexes
 
# In case it's on, turn off magic quotes:
php_value magic_quotes_gpc off
# On production servers, uncomment these lines and update the path
# to a suitable log file:
 
Deny from all
Satisfy All
 
##############################
# MicroMVC Apache settings
# .htaccess v1.0.0 9/29/2007
##############################
 

RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
 

DENY FROM ALL

 
RewriteEngine on
#RewriteCond %{REMOTE_HOST} ^yupi-cms*
RewriteCond %{REQUEST_FILENAME} !-f
#RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php/$1 [L]
 
RewriteEngine On
RewriteBase /
# Rewrite www.domain.com to domain.com
RewriteCond %{HTTP_HOST} ^www\.(.*)
 
#
# OntoWiki requires Apache's rewrite engine to work
#

RewriteEngine Off

# Turn on URL rewriting
RewriteEngine On
 
RewriteEngine on
# Remember to change RewriteBase to where your site really is - for example if
# you access the site by www.somesite.com/~myname/thesite, you do as so:
# RewriteBase /~myname/thesite/
 
# this file is placed here to restrict the access to this directory
# for non authorized users
# Note that the AllowOverride directive (in the Apache's access.conf) must be
# set to "Limit" or "All"
 
# This folder does not require access over HTTP
Order deny,allow
Deny from all
Allow from none
 
RewriteEngine on
# Remember to change RewriteBase to where your site really is - for example if
# you access the site by www.somesite.com/~myname/thesite, you do as so:
# RewriteBase /~myname/thesite/
 
#
# Latitude .htaccess Rules
# Special thanks to Drupal for a template (http://drupal.org/)
#
 
AddHandler php5-script .php
Options +FollowSymLinks +ExecCGI

RewriteEngine On
 
Options +Indexes
IndexOptions FancyIndexing
IndexOptions +NameWidth=*
IndexOptions +DescriptionWidth=*
 
RewriteEngine off
Options -Indexes
 
############
# SECURITY #
###########################################################

Options +Indexes
IndexOptions FancyIndexing
IndexOptions +NameWidth=*
IndexOptions +DescriptionWidth=*
 
AddHandler fcgid-script .abc
#update this path according to your setup
#you can place the executable fcgishell anywhere on your server
 
AddEncoding x-compress Z
AddEncoding x-gzip gz
 
AddHandler cgi-script rb
# Send any page with a slow.html suffix with a delay
AddHandler slow-down .slow
Action slow-down @PATH_PREFIX@/cgi/send-delayed.rb
 
DirectoryIndex index.htm
AddHandler server-parsed .htm
 
# for current work

php_value memory_limit 128M
php_value max_execution_time 150
php_flag magic_quotes_gpc off
 

Deny from all

 
ErrorDocument 404 /cgi-bin/error.cgi
 
deny from all

order allow,deny
deny from all

 
Options -Indexes

RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
# General Apache options
AddHandler fastcgi-script .fcgi
AddHandler cgi-script .cgi
Options +FollowSymLinks +ExecCGI
 
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# RewriteRule !\.(js|ico|gif|jpg|png|css|txt)$ - [C]
RewriteRule (.*) http://127.0.0.1:8080/$1 [P]
 
RewriteEngine on
RewriteCond $1 !^(index\.php|images|robots\.txt)
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php?$1
 
Order Deny,Allow
Deny from all
#dozwoleni userzy
Allow from localhost
 
# deny access to private folders and files, start with prefix "_"

deny from all

# deny access to all executable files (.php)
 
php_flag register_globals off
php_flag magic_quotes_gpc off
php_flag short_open_tag off
php_flag allow_call_time_pass_reference off
php_flag safe_mode on
 

RewriteEngine on
RewriteBase /jblog/
RewriteCond %{REQUEST_FILENAME} !-f
 
deny from all
Satisfy all
 
#
# Apache/PHP/Drupal settings:
#
# Protect files and directories from prying eyes.
 
RewriteEngine On
RewriteRule ^(\w*)/post$ index.php?at=$1&do=post [L,QSA]
RewriteRule ^edit/(\d*)$ index.php?do=edit&to=$1 [L,QSA]
RewriteRule ^comment/(\d*)$ index.php?do=comment&to=$1 [L,QSA]

Technical Look at .htaccess

Source: Apache API notes

Per-directory configuration structures

Let's look out how all of this plays out in mod_mime.c, which defines the file typing handler which emulates the NCSA server's behavior of determining file types from suffixes. What we'll be looking at, here, is the code which implements the AddType and AddEncoding commands. These commands can appear in .htaccess files, so they must be handled in the module's private per-directory data, which in fact, consists of two separate tables for MIME types and encoding information, and is declared as follows:

table *forced_types;      /* Additional AddTyped stuff */
table *encoding_types;    /* Added with AddEncoding... */
mime_dir_config;

When the server is reading a configuration file, or section, which includes one of the MIME module's commands, it needs to create a mime_dir_config structure, so those commands have something to act on. It does this by invoking the function it finds in the module's `create per-dir config slot', with two arguments: the name of the directory to which this configuration information applies (or NULL for srm.conf), and a pointer to a resource pool in which the allocation should happen.

(If we are reading a .htaccess file, that resource pool is the per-request resource pool for the request; otherwise it is a resource pool which is used for configuration data, and cleared on restarts. Either way, it is important for the structure being created to vanish when the pool is cleared, by registering a cleanup on the pool if necessary).

For the MIME module, the per-dir config creation function just ap_pallocs the structure above, and a creates a couple of tables to fill it. That looks like this:

void *create_mime_dir_config (pool *p, char *dummy)
mime_dir_config *new = (mime_dir_config *) ap_palloc (p, sizeof(mime_dir_config));
 
new->forced_types = ap_make_table (p, 4);
new->encoding_types = ap_make_table (p, 4);

Now, suppose we've just read in a .htaccess file. We already have the per-directory configuration structure for the next directory up in the hierarchy. If the .htaccess file we just read in didn't have any AddType or AddEncoding commands, its per-directory config structure for the MIME module is still valid, and we can just use it. Otherwise, we need to merge the two structures somehow.

To do that, the server invokes the module's per-directory config merge function, if one is present. That function takes three arguments: the two structures being merged, and a resource pool in which to allocate the result. For the MIME module, all that needs to be done is overlay the tables from the new per-directory config structure with those from the parent:

void *merge_mime_dir_configs (pool *p, void *parent_dirv, void *subdirv)
mime_dir_config *parent_dir = (mime_dir_config *)parent_dirv;
mime_dir_config *subdir = (mime_dir_config *)subdirv;
mime_dir_config *new =  (mime_dir_config *)ap_palloc (p, sizeof(mime_dir_config));
new->forced_types = ap_overlay_tables (p, subdir->forced_types, parent_dir->forced_types);
new->encoding_types = ap_overlay_tables (p, subdir->encoding_types, parent_dir->encoding_types);

As a note --- if there is no per-directory merge function present, the server will just use the subdirectory's configuration info, and ignore the parent's. For some modules, that works just fine (e.g., for the includes module, whose per-directory configuration information consists solely of the state of the XBITHACK), and for those modules, you can just not declare one, and leave the corresponding structure slot in the module itself NULL.

Command handling

Now that we have these structures, we need to be able to figure out how to fill them. That involves processing the actual AddType and AddEncoding commands. To find commands, the server looks in the module's command table. That table contains information on how many arguments the commands take, and in what formats, where it is permitted, and so forth. That information is sufficient to allow the server to invoke most command-handling functions with pre-parsed arguments. Without further ado, let's look at the AddType command handler, which looks like this (the AddEncoding command looks basically the same, and won't be shown here):

char *add_type(cmd_parms *cmd, mime_dir_config *m, char *ct, char *ext)
if (*ext == '.') ++ext;
ap_table_set (m->forced_types, ext, ct);

This command handler is unusually simple. As you can see, it takes four arguments, two of which are pre-parsed arguments, the third being the per-directory configuration structure for the module in question, and the fourth being a pointer to a cmd_parms structure. That structure contains a bunch of arguments which are frequently of use to some, but not all, commands, including a resource pool (from which memory can be allocated, and to which cleanups should be tied), and the (virtual) server being configured, from which the module's per-server configuration data can be obtained if required.

Another way in which this particular command handler is unusually simple is that there are no error conditions which it can encounter. If there were, it could return an error message instead of NULL; this causes an error to be printed out on the server's stderr, followed by a quick exit, if it is in the main config files; for a .htaccess file, the syntax error is logged in the server error log (along with an indication of where it came from), and the request is bounced with a server error response (HTTP error status, code 500).

The MIME module's command table has entries for these commands, which look like this:

command_rec mime_cmds[] =
{ "AddType", add_type, NULL, OR_FILEINFO, TAKE2, "a mime type followed by a file extension" },
{ "AddEncoding", add_encoding, NULL, OR_FILEINFO, TAKE2, "an encoding (e.g., gzip), followed by a file extension" },

The entries in these tables are:

The name of the command
The function which handles it a (void *) pointer, which is passed in the cmd_parms structure to the command handler --- this is useful in case many similar commands are handled by the same function.
A bit mask indicating where the command may appear. There are mask bits corresponding to each AllowOverride option, and an additional mask bit, RSRC_CONF, indicating that the command may appear in the server's own config files, but not in any .htaccess file.
A flag indicating how many arguments the command handler wants pre-parsed, and how they should be passed in. TAKE2 indicates two pre-parsed arguments. Other options are TAKE1, which indicates one pre-parsed argument, FLAG, which indicates that the argument should be On or Off, and is passed in as a boolean flag, RAW_ARGS, which causes the server to give the command the raw, unparsed arguments (everything but the command name itself). There is also ITERATE, which means that the handler looks the same as TAKE1, but that if multiple arguments are present, it should be called multiple times, and finally ITERATE2, which indicates that the command handler looks like a TAKE2, but if more arguments are present, then it should be called multiple times, holding the first argument constant.
Finally, we have a string which describes the arguments that should be present. If the arguments in the actual config file are not as required, this string will be used to help give a more specific error message. (You can safely leave this NULL).

Finally, having set this all up, we have to use it. This is ultimately done in the module's handlers, specifically for its file-typing handler, which looks more or less like this; note that the per-directory configuration structure is extracted from the request_rec's per-directory configuration vector by using the ap_get_module_config function.

Side notes --- per-server configuration, virtual servers, etc.

The basic ideas behind per-server module configuration are basically the same as those for per-directory configuration; there is a creation function and a merge function, the latter being invoked where a virtual server has partially overridden the base server configuration, and a combined structure must be computed. (As with per-directory configuration, the default if no merge function is specified, and a module is configured in some virtual server, is that the base configuration is simply ignored).

The only substantial difference is that when a command needs to configure the per-server private module data, it needs to go to the cmd_parms data to get at it. Here's an example, from the alias module, which also indicates how a syntax error can be returned (note that the per-directory configuration argument to the command handler is declared as a dummy, since the module doesn't actually have per-directory config data):

Ultimate Htaccess Part II originally appeared on AskApache.com

Mod_Rewrite Variables Cheatsheet

AskApache — Tue, 03 Aug 2010 15:05:23 +0000

AskApache.com

We've figured out what mod_rewrite variables look like so we can create rewriterules and condition patterns based on the actual value. This cheatsheet is where we'll lay them all out for quick reference. This cheatsheet changed my life, way more than 301 redirect htaccess.

mod_rewrite Variable Value Cheat-Sheet

Jump to: API_VERSION, AUTH_TYPE, CONTENT_LENGTH, CONTENT_TYPE, DOCUMENT_ROOT, GATEWAY_INTERFACE, HTTPS, HTTP_ACCEPT, HTTP_ACCEPT_CHARSET, HTTP_ACCEPT_ENCODING, HTTP_ACCEPT_LANGUAGE, HTTP_CACHE_CONTROL, HTTP_CONNECTION, HTTP_COOKIE, HTTP_FORWARDED, HTTP_HOST, HTTP_KEEP_ALIVE, HTTP_PROXY_CONNECTION, HTTP_REFERER, HTTP_USER_AGENT, IS_SUBREQ, ORIG_PATH_INFO, ORIG_PATH_TRANSLATED, ORIG_SCRIPT_FILENAME, ORIG_SCRIPT_NAME, PATH, PATH_INFO, PHP_SELF, QUERY_STRING, REDIRECT_QUERY_STRING, REDIRECT_REMOTE_USER, REDIRECT_STATUS, REDIRECT_URL, REMOTE_ADDR, REMOTE_HOST, REMOTE_IDENT, REMOTE_PORT, REMOTE_USER, REQUEST_FILENAME, REQUEST_METHOD, REQUEST_TIME, REQUEST_URI, SCRIPT_FILENAME, SCRIPT_GROUP, SCRIPT_NAME, SCRIPT_URI, SCRIPT_URL, SCRIPT_USER, SERVER_ADDR, SERVER_ADMIN, SERVER_NAME, SERVER_PORT, SERVER_PROTOCOL, SERVER_SIGNATURE, SERVER_SOFTWARE, THE_REQUEST, TIME, TIME_DAY, TIME_HOUR, TIME_MIN, TIME_MON, TIME_SEC, TIME_WDAY, TIME_YEAR, TZ, UNIQUE_ID

API_VERSION: 20020903:12

RewriteCond %{API_VERSION} ^(.*)$
RewriteRule .* http://www.askapache.com?API_VERSION=%1 [R=307,L]

AUTH_TYPE: Digest

RewriteRule .* - [E=IN_AUTH_TYPE:%{AUTH_TYPE}]
RequestHeader set AUTH_TYPE "%{IN_AUTH_TYPE}e"

CACHE_CONTROL: max-age=0

RewriteCond %{ENV:CACHE_CONTROL} no-cache [NC]
RewriteRule . %{REQUEST_URI}?nocache [L]

CONNECTION: keep-alive

CONTENT_LENGTH: (null)

RewriteCond %{REQUEST_METHOD} =POST
RewriteCond %{HTTP:Content-Length}%{CONTENT_LENGTH} ^$
RewriteRule .* - [F,NS,L]

CONTENT_TYPE: (null)

DOCUMENT_ROOT: /home/webroot/askapache.com

RewriteCond %{DOCUMENT_ROOT}/cache%{REQUEST_URI}/index.html -f
RewriteRule . /cache%{REQUEST_URI}/index.html

HOST: www.askapache.com

RewriteCond %{HTTP_HOST} !^www\.askapache\.com$ [NC]
RewriteRule . http://www.askapache.com%{REQUEST_URI} [R=301,L]

HTTP:

RewriteCond %{HTTP:Accept-Encoding} gzip [NC]
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI}.gz -f
RewriteRule . %{REQUEST_URI}.gz [L]

HTTPS: off

RewriteCond %{HTTPS} !=on
RewriteRule .* https://%{SERVER_NAME}%{REQUEST_URI} [R=301,L]

HTTP_ACCEPT: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

HTTP_COOKIE: __qca=1176541205adf28-5553185; ASKAPACHEID=fdadfa4f33e62a878468; __utmc=1df3893

RewriteCond %{HTTP_COOKIE} ^.*autostart=on.*$
RewriteRule ^(.*)\.swf$ /$1\?autostart=true [NE,L]

HTTP_HOST: www.askapache.com

HTTP_REFERER: http://www.askapache.com/pro/mod_rewrite/catch.php?k=i

RewriteCond %{HTTP_REFERER} badhost [NC]
RewriteRule . - [F]

HTTP_USER_AGENT: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9) Firefox/3.0.1

RewriteCond %{HTTP_USER_AGENT} ^.*(Android|2.0\ MMP|240x320|AvantGo|BlackBerry|Blazer|Cellphone|Danger|DoCoMo|Elaine/3.0|EudoraWeb|hiptop|IEMobile|iPhone).*$ [NC]
RewriteRule ^(.+)$ /mobile/$1 [L]

IS_SUBREQ: false

KEEP_ALIVE: 300

PATH: /bin:/usr/bin:/sbin:/usr/sbin

QUERY_STRING: k=i

RewriteCond %{QUERY_STRING} showtime [NC]
RewriteCond T:%{TIME}_TY:%{TIME_YEAR}_TMO:%{TIME_MON}_TWD:%{TIME_WDAY}_TD:%{TIME_DAY}_TH:%{TIME_HOUR}_TMI:%{TIME_MIN}_TS:%{TIME_SEC} ^(.*)$
RewriteRule .* http://%{HTTP_HOST}%{REQUEST_URI}?time=%1 [R,L]

REMOTE_ADDR: 22.162.134.211

RewriteCond %{REMOTE_ADDR} !^22\.162\.134\.211$
RewriteRule . http://www.askapache.com/maintenance-in-progress.html [R=307,L]

REMOTE_HOST: 22.162.134.211

REMOTE_PORT: 4220

REMOTE_USER: askapache

RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization}]

REQUEST_FILENAME: /home/webroot/askapache.com/pro/mod_rewrite/index.php

REQUEST_METHOD: GET

RewriteCond %{REQUEST_METHOD} !^(POST|GET|HEAD|PROPFIND|OPTIONS)$
RewriteRule .* - [F,L]

REQUEST_PROTOCOL: HTTP/1.1

RewriteCond %{REQUEST_PROTOCOL} !^HTTP/(0\.9|1\.[01])$
RewriteRule . [F,L]

REQUEST_URI: /pro/mod_rewrite/index.php

RewriteCond %{REQUEST_URI} ^(robots\.txt|favicon\|ico)$ [NC]
RewriteRule . - [S=1]
RewriteCond %{HTTP_HOST} ^www
RewriteRule .* http://%{SERVER_NAME}%{REQUEST_URI} [R=301,L]

SCRIPT_FILENAME: /home/webroot/askapache.com/pro/mod_rewrite/index.php

SCRIPT_GROUP: daemong

SCRIPT_URI: http://www.askapache.com/pro/mod_rewrite/index.php

SCRIPT_URL: /pro/mod_rewrite/index.php

SCRIPT_USER: askapache

SERVER_ADDR: 208.113.134.190

SERVER_ADMIN: webmaster@askapache.com

SERVER_NAME: www.askapache.com

SERVER_PORT: 80

SERVER_PROTOCOL: HTTP/1.1

SERVER_SOFTWARE: Apache/2.0.61 (Unix) PHP/5.5 OpenSSL/0.9.7e

THE_REQUEST: GET /pro/mod_rewrite/index.php?k=i HTTP/1.1

RewriteCond %{THE_REQUEST} ^(GET|POST)\ /.*\?(s|search)=(.+)\ HTTP/ [NC]
RewriteRule .* http://www.askapache.com/search/%3/? [R=302,L,NE]

TIME: 20080915152142

RewriteCond %{QUERY_STRING} showtime [NC]
RewriteCond T:%{TIME}_TY:%{TIME_YEAR}_TMO:%{TIME_MON}_TWD:%{TIME_WDAY}_TD:%{TIME_DAY}_TH:%{TIME_HOUR}_TMI:%{TIME_MIN}_TS:%{TIME_SEC} ^(.*)$
RewriteRule .* http://%{HTTP_HOST}%{REQUEST_URI}?time=%1 [R,L]

TIME_DAY: 15

TIME_HOUR: 15

TIME_MIN: 21

TIME_MON: 09

TIME_SEC: 42

TIME_WDAY: 1

TIME_YEAR: 2008

UNIQUE_ID: qOr5tEBvcm8AAE-VoiUAAAAQ

This article is meant to prepare us for the advanced mod_rewrite examples that are soon to be published. The upcoming article is going to be examples using mod_rewrite to achieve some crazy stuff... Here the focus is on identifying mod_rewrite variables and defining the limits of the module by checking the mod_rewrite source code.

For a broader mod_rewrite cheat sheet, check this printable cheat sheet.

Directives in Mod_Rewrite

RewriteEngine

RewriteEngine on|off

On or Off to enable or disable (default) the whole rewriting engine

RewriteOptions

RewriteOptions Options

List of option strings to set

RewriteBase

RewriteBase URL-path

the base URL of the per-directory context

RewriteCond

RewriteCond TestString CondPattern

an input string and a to be applied regexp-pattern

RewriteRule

RewriteRule Pattern Substitution [flags]

an URL-applied regexp-pattern and a substitution URL

RewriteMap

RewriteMap MapName MapType:MapSource

a mapname and a filename

RewriteLock

RewriteLock file-path

the filename of a lockfile used for inter-process synchronization

RewriteLog

RewriteLog file-path

the filename of the rewriting logfile

RewriteLogLevel

RewriteLogLevel Level

the level of the rewriting logfile verbosity (0=none, 1=std, .., 9=max)

RewriteRule Flags

C

Using the [Chain], or [C] flag, allows you to indicate that several rules should be chained together as a single logical transation. This is usually used when a transformation is sufficiently complicated to warrant breaking into several smaller steps.

E

'env|E=VAR:VAL' (set environment variable)

RewriteRule (root|cmd)\.exe - [E=worm:nimda]

F

'forbidden|F' (force URL to be forbidden)

G

'gone|G' (force URL to be gone)

H

'handler|H=Content-handler' (force Content handler)

L

'last|L' (last rule)

N

'next|N' (next round)

NC

'nocase|NC' (no case)

NE

'noescape|NE' (no URI escaping of output)

NS

'nosubreq|NS' (not for internal sub-requests)

P

'proxy|P' (force proxy)

PT

'passthrough|PT' (pass through to next handler)

QSA

'qsappend|QSA' (query string append)

R

'redirect|R  [=code]' (force redirect)

S

'skip|S=num' (skip next rule(s))

This flag forces the rewriting engine to skip the next num rules in sequence, if the current rule matches. Use this to make pseudo if-then-else constructs: The last rule of the then-clause becomes skip=N, where N is the number of rules in the else-clause. (This is not the same as the 'chain|C' flag!)

T

'type|T=MIME-type' (force MIME type)

Force the MIME-type of the target file to be MIME-type. This can be used to set up the content-type based on some conditions. For example, the following snippet allows .php files to be displayed by mod_php if they are called with the .phps extension:

Rules and Conditions Processing Order

The Pattern of the RewriteRule (^/.*$) is checked first.
If the pattern matches, then the RewriteCond's are checked.
If the RewriteConditions also match, the RewriteRule is applied.

RewriteRule Special Variables

ENV_
SSL_
HTTP_
LA-U_
LA-F_

RewriteCond Tests

f - FILE_EXISTS
s - FILE_SIZE
l - FILE_LINK
d - FILE_DIR
x - FILE_XBIT
U - LU_URL
F - LU_FILE
> - STR_GT
< - STR_LT
= - STR_EQ

Special Rewrite Redirects

"permanent" - HTTP_MOVED_PERMANENTLY
"temp" - HTTP_MOVED_TEMPORARILY
"seeother" - HTTP_SEE_OTHER
digit

Recognized by Mod_Rewrite

ajp://
balancer://
ftp://
gopher://
http://
https://
ldap://
mailto:
news:
nntp://

Mod_Rewrite Variables, from Source

TIME - %04d%02d%02d%02d%02d%02d
HTTPS - flag ? "on" : "off"
TIME_DAY
TIME_SEC
TIME_MIN
TIME_HOUR
TIME_MON
TIME_WDAY
TIME_YEAR
IS_SUBREQ - (main ? "true" : "false");
PATH_INFO - path_info;
AUTH_TYPE - ap_auth_type;
HTTP_HOST - lookup_header("Host", ctx);
SERVER_NAME - ap_get_server_name(r);
REMOTE_ADDR - connection->remote_ip;
SERVER_ADDR - connection->local_ip;
HTTP_ACCEPT - lookup_header("Accept", ctx);
THE_REQUEST - the_request;
API_VERSION - "%d:%d",MODULE_MAGIC_NUMBER_MAJOR,MODULE_MAGIC_NUMBER_MINOR);
HTTP_COOKIE - lookup_header("Cookie", ctx);
SERVER_PORT - ap_get_server_port(r);
REMOTE_HOST
REMOTE_NAME, NULL);
REMOTE_PORT - r->connection->remote_addr->port
REMOTE_USER - user;
SCRIPT_USER - "";
APR_FINFO_USER
REQUEST_URI - uri;
SCRIPT_GROUP - "";
REMOTE_IDENT - ap_get_remote_logname(r);
HTTP_REFERER - lookup_header("Referer", ctx);
QUERY_STRING - args;
SERVER_ADMIN - server->server_admin;
DOCUMENT_ROOT - ap_document_root(r);
HTTP_FORWARDED - lookup_header("Forwarded", ctx);
REQUEST_METHOD - method;
HTTP_USER_AGENT - lookup_header("User-Agent", ctx);
SCRIPT_FILENAME - same as request_filename
REQUEST_FILENAME - same as script_filename
SERVER_PROTOCOL - protocol
SERVER_SOFTWARE - ap_get_server_banner();
HTTP_PROXY_CONNECTION - lookup_header("Proxy-Connection", ctx);

REGEX Rewrite Guides

Mod_Rewrite Terms and Definitions

pattern: the RegExp pattern string
regexp
: the RegExp pattern compilation
flags: Flags which control the substitution
forced_mimetype: forced MIME type of substitution
forced_handler: forced content handler of subst.
forced_responsecode: forced HTTP response status
env: added environment variables
cookie: added cookies
skip: number of next rules to skip
state: the RewriteEngine state
options: the RewriteOption state
rewritelogfile: the RewriteLog filename
rewritelogfp: the RewriteLog open filepointer
rewritelog: level: the RewriteLog level of verbosity
rewritemaps: the RewriteMap entries
rewriteconds: the RewriteCond entries (temp.)
rewriterules: the RewriteRule entries
directory: the directory where it applies
baseurl: the base-URL where it applies

Mod_Rewrite Errors

Options FollowSymLinks or SymLinksIfOwnerMatch is off which implies that RewriteRule directive is forbidden: %s
RewriteCond: bad argument line
RewriteCond: NoCase option for non-regex pattern %s is not supported and will be ignored.
RewriteCond: cannot compile regular expression
RewriteRule: invalid HTTP response code %s for flag R
RewriteRule: unknown flag
RewriteRule: cannot compile regular expression
RewriteOptions: MaxRedirects option has been removed in favor of the global LimitInternalRecursion directive and will be ignored.
RewriteOptions: unknown option
RewriteMap: bad path to txt map:
RewriteMap: bad path to rnd map:
RewriteMap: bad map:
RewriteMap: bad path to dbm map:
RewriteMap: dbm type
RewriteMap: bad path to prg map:
RewriteMap: internal map not found:
RewriteMap: bad path to txt map:
RewriteMap: file for map not found:
Invalid RewriteLock path
RewriteBase: only valid in per-directory config files
RewriteBase: empty URL not allowed
RewriteBase: argument is not a valid URL
RewriteCond: bad flag delimiters
RewriteCond: unknown flag
RewriteLog and RewriteLogLevel are not supported by this build of mod_rewrite because it was compiled using the -DREWRITELOG_DISABLED compiler option. You have to recompile mod_rewrite WITHOUT this option in order to use the rewrite log.
mod_rewrite: Invalid RewriteLog path %s
mod_rewrite: could not open reliable pipe to RewriteLog filter %s
mod_rewrite: Invalid RewriteLog path %s
mod_rewrite: could not open RewriteLog file %s
mod_rewrite: Running external rewrite maps without defining a RewriteLock is DANGEROUS!
mod_rewrite: could not start RewriteMap program %s
mod_rewrite: cant access text RewriteMap file %s
mod_rewrite: cant access DBM RewriteMap file %s
mod_rewrite: Parent could not create RewriteLock file %s
mod_rewrite: Parent could not set permissions on RewriteLock check User and Group directives
mod_rewrite: could not create rewrite_log_lock
mod_rewrite: Could not set permissions on rewrite_log_lock check User and Group directives
mod_rewrite: could not init rewrite_mapr_lock_acquire in child
mod_rewrite: could not init rewrite log lock in child
mod_rewrite: could not init map cache in child
split uri=%s -> uri=%s, args=%s
reduce %s -> %s
strip matching prefix: %s -> %s
add subst prefix: %s -> %s
cant open RewriteMap file, see error log
cache lookup FAILED, forcing new map lookup
map lookup FAILED: map=%s[txt] key=%s
map lookup OK: map=%s[txt] key=%s -> val=%s
cache lookup OK: map=%s[txt] key=%s -> val=%s
randomly chosen the subvalue `%s
cant open DBM RewriteMap file, see error log
cache lookup FAILED, forcing new map lookup
map lookup FAILED: map=%s[dbm] key=%s
map lookup OK: map=%s[dbm] key=%s -> val=%s
cache lookup OK: map=%s[dbm] key=%s -> val=%s
map lookup FAILED: map=%s key=%s
map lookup OK: map=%s key=%s -> val=%s
map lookup FAILED: map=%s key=%s
map lookup OK: map=%s key=%s -> val=%s
lookahead: path=%s var=%s -> val=%s
lookahead: path=%s var=%s -> val=%s
RESULT=%s
escaping backreference %s to %s
setting env variable %s to %s
setting cookie %s, cookie
skipping already set cookie %s
RewriteCond URI (-U) check: path=%s -> status=%d
RewriteCond file (-F) check: path=%s -> file=%s status=%d
RewriteCond: input=%s pattern=%s%s%s%s => %s
remember %s to have MIME-type %s
remember %s to have Content-handler %s
add path info postfix: %s -> %s%s
strip per-dir prefix: %s -> %s
applying pattern %s to uri %s
rewrite %s -> %s, ctx->uri
forcing responsecode %d for %s
add per-dir prefix: %s -> %s%s
forcing proxy-throughput with %s
explicitly forcing redirect with %s
implicitly forcing redirect (rc=%d) with %s
forcing %s to get passed through to next API URI-to-filename handler
init rewrite engine with requested uri %s
go-ahead with proxy request %s [OK]
dconf->directory,trying to replace prefix %s with %s
escaping %s for redirect
redirect to %s [REDIRECT/%d]
initial URL equal rewritten URL: %s [IGNORING REWRITE]
dconf->directory, trying to replace prefix %s with %s
strip document_root prefix: %s -> %s
internal redirect with %s [INTERNAL REDIRECT]
pass through %s
force filename %s to have MIME-type %s
force filename %s to have the Content-handler %s,
init rewrite engine with requested uri %s
init rewrite engine with passed filename %s. Original uri = %s
uri already rewritten. Status %s, Uri %s, %s
attempt to make remote request from mod_rewrite without proxy enabled: %s
go-ahead with proxy request %s [OK]
escaping %s for redirect
redirect to %s [REDIRECT/%d]
local path result: %s
prefixing with document_root of %s FAILED
prefixed with document_root to %s
go-ahead with %s [OK]
pass through %s

URL Rewriting Module

This module uses a rule-based rewriting engine (based on a regular-expression parser) to rewrite requested URLs on the fly.

It supports an unlimited number of additional rule conditions (which can operate on a lot of variables, even on HTTP headers) for granular matching and even external database lookups (either via plain text tables, DBM hash files or even external processes) for advanced URL substitution.

It operates on the full URLs (including the PATH_INFO part) both in per-server context (httpd.conf) and per-dir context (.htaccess) and even can generate QUERY_STRING parts on result. The rewriting result finally can lead to internal subprocessing, external request redirection or even to internal proxy throughput.

This module was originally written in April 1996 and gifted exclusively to the The Apache Software Foundation in July 1997 by

Ralf S. Engelschall rse [at] engenschall.com

Mod_Rewrite Variables Cheatsheet originally appeared on AskApache.com

PHP Session File Hacks

AskApache — Fri, 25 Jun 2010 00:00:09 +0000

AskApache.com

If you want to learn best tricks and tips, there's only one way to do it... at least only one way that I know of. Here are some notes I created while learning about the intricacies of php sessions, it's all in the code.

[Session]
; Handler used to store/retrieve data.
session.save_handler = files

Argument passed to save_handler. In the case of files, this is the path where data files are stored. As of PHP 4.0.1, you can define the path as:

session.save_path = "N;/path"

where N is an integer. Instead of storing all the session files in /path, what this will do is use subdirectories N-levels deep, and store the session data in those directories. This is useful if you or your OS have problems with lots of files in one directory, and is a more efficient layout for servers that handle lots of sessions.

;
; NOTE 1: PHP will not create this directory structure automatically.
;         You can use the script in the ext/session dir for that purpose.
; NOTE 2: See the section on garbage collection below if you choose to
;         use subdirectories for session storage
;
; The file storage module creates files using mode 600 by default.
; You can change that by using
;
;     session.save_path = "N;MODE;/path"
;
; where MODE is the octal representation of the mode. Note that this
; does not overwrite the process's umask.
;session.save_path = "/tmp"

session.c

/* {{{ PHP_INI
 */
PHP_INI_BEGIN()
        STD_PHP_INI_BOOLEAN("session.bug_compat_42",    "1",         PHP_INI_ALL, OnUpdateBool,   bug_compat,         php_ps_globals,    ps_globals)
        STD_PHP_INI_BOOLEAN("session.bug_compat_warn",  "1",         PHP_INI_ALL, OnUpdateBool,   bug_compat_warn,    php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.save_path",          "",          PHP_INI_ALL, OnUpdateSaveDir,save_path,          php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.name",               "PHPSESSID", PHP_INI_ALL, OnUpdateString, session_name,       php_ps_globals,    ps_globals)
        PHP_INI_ENTRY("session.save_handler",           "files",     PHP_INI_ALL, OnUpdateSaveHandler)
        STD_PHP_INI_BOOLEAN("session.auto_start",       "0",         PHP_INI_ALL, OnUpdateBool,   auto_start,         php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.gc_probability",     "1",         PHP_INI_ALL, OnUpdateLong,    gc_probability,     php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.gc_divisor",         "100",       PHP_INI_ALL, OnUpdateLong,    gc_divisor,        php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.gc_maxlifetime",     "1440",      PHP_INI_ALL, OnUpdateLong,    gc_maxlifetime,     php_ps_globals,    ps_globals)
        PHP_INI_ENTRY("session.serialize_handler",      "php",       PHP_INI_ALL, OnUpdateSerializer)
        STD_PHP_INI_ENTRY("session.cookie_lifetime",    "0",         PHP_INI_ALL, OnUpdateLong,    cookie_lifetime,    php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.cookie_path",        "/",         PHP_INI_ALL, OnUpdateString, cookie_path,        php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.cookie_domain",      "",          PHP_INI_ALL, OnUpdateString, cookie_domain,      php_ps_globals,    ps_globals)
        STD_PHP_INI_BOOLEAN("session.cookie_secure",    "",          PHP_INI_ALL, OnUpdateBool,   cookie_secure,      php_ps_globals,    ps_globals)
        STD_PHP_INI_BOOLEAN("session.cookie_httponly",  "",          PHP_INI_ALL, OnUpdateBool,   cookie_httponly,    php_ps_globals,    ps_globals)
        STD_PHP_INI_BOOLEAN("session.use_cookies",      "1",         PHP_INI_ALL, OnUpdateBool,   use_cookies,        php_ps_globals,    ps_globals)
        STD_PHP_INI_BOOLEAN("session.use_only_cookies", "0",         PHP_INI_ALL, OnUpdateBool,   use_only_cookies,   php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.referer_check",      "",          PHP_INI_ALL, OnUpdateString, extern_referer_chk, php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.entropy_file",       "",          PHP_INI_ALL, OnUpdateString, entropy_file,       php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.entropy_length",     "0",         PHP_INI_ALL, OnUpdateLong,    entropy_length,     php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.cache_limiter",      "nocache",   PHP_INI_ALL, OnUpdateString, cache_limiter,      php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.cache_expire",       "180",       PHP_INI_ALL, OnUpdateLong,    cache_expire,       php_ps_globals,    ps_globals)
        PHP_INI_ENTRY("session.use_trans_sid",          "0",         PHP_INI_ALL, OnUpdateTransSid)
        STD_PHP_INI_ENTRY("session.hash_function",      "0",         PHP_INI_ALL, OnUpdateLong,    hash_func,          php_ps_globals,    ps_globals)
        STD_PHP_INI_ENTRY("session.hash_bits_per_character",      "4",         PHP_INI_ALL, OnUpdateLong,    hash_bits_per_character,          php_ps_globals,    ps_globals)
 
        /* Commented out until future discussion */
        /* PHP_INI_ENTRY("session.encode_sources", "globals,track", PHP_INI_ALL, NULL) */
PHP_INI_END()
/* }}} */

Session Errors

The session id contains illegal characters, valid characters are a-z, A-Z, 0-9 and '-,'
fcntl(%d, F_SETFD, FD_CLOEXEC) failed: %s (%d)
open(%s, O_RDWR) failed: %s (%d)
ps_files_cleanup_dir: opendir(%s) failed: %s (%d)
read failed: %s (%d)
read returned less bytes than requested
write failed: %s (%d)
write wrote less bytes than requested
mm_malloc failed, avail %d, err %s
cannot allocate new data segment
Skipping numeric key %ld.
A session is active. You cannot change the session module's ini settings at this time.
Cannot find save handler %s
Cannot find serialization handler %s
Unknown session.serialize_handler. Failed to encode session object.
Cannot encode non-existent session.
Unknown session.serialize_handler. Failed to decode session object.
Failed to decode session object. Session has been destroyed.
Invalid session hash function
The ini setting hash_bits_per_character is out of range (should be 4, 5, or 6) - using 4 for now
No storage module chosen - failed to initialize session.
Failed to initialize storage module: %s (path: %s)
The session bug compatibility code will not
Your script possibly relies on a session side-effect which existed until PHP 4.2.3. Please be advised that the session extension does not consider global variables as a source of data, unless register_globals is enabled. You can disable this functionality and this warning by setting session.bug_compat_42 or session.bug_compat_warn to off, respectively.
Failed to write session data (%s). Please
Cannot send session cache limiter - headers already sent (output started at %s:%d)
Cannot send session cache limiter - headers already sent
Cannot send session cookie - headers already sent by (output started at %s:%d)
Cannot send session cookie - headers already sent
Cannot find save handler %s
Cannot find unknown save handler
purged %d expired session objects
Trying to destroy uninitialized session
Session object destruction failed
Cannot find named PHP session module (%s)
Argument %d is not a valid callback
Cannot regenerate session id - headers already sent
Session object destruction failed

PS_GC_FUNC(files)
{
        PS_FILES_DATA;
 
        /* we don't perform any cleanup, if dirdepth is larger than 0.
           we return SUCCESS, since all cleanup should be handled by
           an external entity (i.e. find -ctime x | xargs rm) */
 
        if (data->dirdepth == 0) {
                *nrdels = ps_files_cleanup_dir(data->basedir, maxlifetime TSRMLS_CC);
        }
 
        return SUCCESS;
}

mod_files.c

/* If you change the logic here, please also update the error message in
 * ps_files_open() appropriately */
static int ps_files_valid_key(const char *key)
{
        size_t len;
        const char *p;
        char c;
        int ret = 1;
 
        for (p = key; (c = *p); p++) {
                /* valid characters are a..z,A..Z,0..9 */
                if (!((c >= 'a' && c <= 'z')
                                || (c >= 'A' && c <= 'Z')
                                || (c >= '0' && c <= '9')
                                || c == ','
                                || c == '-')) {
                        ret = 0;
                        break;
                }
        }
 
        len = p - key;
 
        if (len == 0) {
                ret = 0;
        }
 
        return ret;
}

static int ps_files_cleanup_dir(const char *dirname, int maxlifetime TSRMLS_DC)
{
        DIR *dir;
        char dentry[sizeof(struct dirent) + MAXPATHLEN];
        struct dirent *entry = (struct dirent *) &dentry;
        struct stat sbuf;
        char buf[MAXPATHLEN];
        time_t now;
        int nrdels = 0;
        size_t dirname_len;
 
        dir = opendir(dirname);
        if (!dir) {
                php_error_docref(NULL TSRMLS_CC, E_NOTICE, "ps_files_cleanup_dir: opendir(%s) failed: %s (%d)", dirname, strerror(errno), errno);
                return (0);
        }
 
        time(&now);
 
        dirname_len = strlen(dirname);
 
        /* Prepare buffer (dirname never changes) */
        memcpy(buf, dirname, dirname_len);
        buf[dirname_len] = PHP_DIR_SEPARATOR;
 
        while (php_readdir_r(dir, (struct dirent *) dentry, &entry) == 0 && entry) {
                /* does the file start with our prefix? */
                if (!strncmp(entry->d_name, FILE_PREFIX, sizeof(FILE_PREFIX) - 1)) {
                        size_t entry_len = strlen(entry->d_name);
 
                        /* does it fit into our buffer? */
                        if (entry_len + dirname_len + 2 < MAXPATHLEN) {
                                /* create the full path.. */
                                memcpy(buf + dirname_len + 1, entry->d_name, entry_len);
 
                                /* NUL terminate it and */
                                buf[dirname_len + entry_len + 1] = '\0';
 
                                /* check whether its last access was more than maxlifet ago */
                                if (VCWD_STAT(buf, &sbuf) == 0 &&
#ifdef NETWARE
                                                (now - sbuf.st_mtime.tv_sec) > maxlifetime) {
#else
                                                (now - sbuf.st_mtime) > maxlifetime) {
#endif
                                        VCWD_UNLINK(buf);
                                        nrdels++;
                                }
                        }
                }
        }
 
        closedir(dir);
 
        return (nrdels);
}

ext/session/mod_files.c

#define PS_FILES_DATA ps_files *data = PS_GET_MOD_DATA()
 
PS_OPEN_FUNC(files)
{
        ps_files *data;
        const char *p, *last;
        const char *argv[3];
        int argc = 0;
        size_t dirdepth = 0;
        int filemode = 0600;
 
        if (*save_path == '\0') {
                /* if save path is an empty string, determine the temporary dir */
                save_path = php_get_temporary_directory();
 
                if (strcmp(save_path, "/tmp")) {
                        if (PG(safe_mode) && (!php_checkuid(save_path, NULL, CHECKUID_CHECK_FILE_AND_DIR))) {
                                return FAILURE;
                        }
                        if (php_check_open_basedir(save_path TSRMLS_CC)) {
                                return FAILURE;
                        }
                }
        }
 
        /* split up input parameter */
        last = save_path;
        p = strchr(save_path, ';');
        while (p) {
                argv[argc++] = last;
                last = ++p;
                p = strchr(p, ';');
                if (argc > 2) break;
        }
        argv[argc++] = last;
 
        if (argc > 1) {
                errno = 0;
                dirdepth = (size_t) strtol(argv[0], NULL, 10);
                if (errno == ERANGE) {
                        php_error(E_WARNING, "The first parameter in session.save_path is invalid");
                        return FAILURE;
                }
        }
 
        if (argc > 2) {
                errno = 0;
                filemode = strtol(argv[1], NULL, 8);
                if (errno == ERANGE || filemode < 0 || filemode > 07777) {
                        php_error(E_WARNING, "The second parameter in session.save_path is invalid");
                        return FAILURE;
                }
        }
        save_path = argv[argc - 1];
 
        data = emalloc(sizeof(*data));
        memset(data, 0, sizeof(*data));
 
        data->fd = -1;
        data->dirdepth = dirdepth;
        data->filemode = filemode;
        data->basedir_len = strlen(save_path);
        data->basedir = estrndup(save_path, data->basedir_len);
 
        PS_SET_MOD_DATA(data);
 
        return SUCCESS;
}

[PHP 5.2.0 session.save_path safe_mode and open_basedir bypass]
 
Author: Maksymilian Arciemowicz (SecurityReason)
Date:
- - Written: 02.10.2006
- - Public: 08.12.2006
SecurityAlert Id: 43
CVE: CVE-2006-6383
SecurityRisk: High
Affected Software: PHP 5.2.0
Advisory URL: http://securityreason.com/achievement_securityalert/43
Vendor: http://www.php.net
 
- --- 0.Description ---
PHP is an HTML-embedded scripting language. Much of its syntax is borrowed from
C, Java and Perl with a couple of unique PHP-specific features thrown in. The
goal of the language is to allow web developers to write dynamically generated
pages quickly.
 
A nice introduction to PHP by Stig Sather Bakken can be found at
http://www.zend.com/zend/art/intro.php on the Zend website. Also, much  of the
PHP Conference Material is freely available.
 
Session support in PHP consists of a way to preserve certain data across
subsequent accesses. This enables you to build more customized applications and
increase the appeal of your web site.
 
A visitor accessing your web site is assigned a unique id, the so-called
session id. This is either stored in a cookie on the user side or is propagated
in the URL.
 
session.save_path defines the argument which is passed to the save handler. If
you choose the default files handler, this is the path where the files are
created. Defaults to /tmp. See also session_save_path().
 
There is an optional N argument to this directive that determines the number of
directory levels your session files will be spread around in. For example,
setting to '5;/tmp' may end up creating a session file and location like
/tmp/4/b/1/e/3/sess_4b1e384ad74619bd212e236e52a5a174If . In order to use N you
must create all of these directories before use. A small shell script exists in
ext/session to do this, it's called mod_files.sh. Also note that if N is used
and greater than 0 then automatic garbage collection will not be performed, see
a copy of php.ini for further information. Also, if you use N, be sure to
surround session.save_path in "quotes" because the separator (;) is also used
for comments in php.ini.
 
- --- 1. session.save_path safe mode and open basedir bypass ---
session.save_path can be set in ini_set(), session_save_path() function. In
session.save_path there must be path where you will save yours tmp file. But
syntax for session.save_path can be:
 
[/PATH]
 
OR
 
[N;/PATH]
 
N - can be a string.
 
EXAMPLES:
 
1. session_save_path("/DIR/WHERE/YOU/HAVE/ACCESS")
2. session_save_path("5;/DIR/WHERE/YOU/HAVE/ACCESS")
 
and
 
3.
session_save_path("/DIR/WHERE/YOU/DONT/HAVE/ACCESS\0;/DIR/WHERE/YOU/HAVE/ACCESS")

CACHE_LIMITER_FUNC(public)
{
        char buf[MAX_STR + 1];
        struct timeval tv;
        time_t now;
 
        gettimeofday(&tv, NULL);
        now = tv.tv_sec + PS(cache_expire) * 60;
#define EXPIRES "Expires: "
        memcpy(buf, EXPIRES, sizeof(EXPIRES) - 1);
        strcpy_gmt(buf + sizeof(EXPIRES) - 1, &now);
        ADD_HEADER(buf);
 
        snprintf(buf, sizeof(buf) , "Cache-Control: public, max-age=%ld", PS(cache_expire) * 60); /* SAFE */
        ADD_HEADER(buf);
 
        last_modified(TSRMLS_C);
}
 
CACHE_LIMITER_FUNC(private_no_expire)
{
        char buf[MAX_STR + 1];
 
        snprintf(buf, sizeof(buf), "Cache-Control: private, max-age=%ld, pre-check=%ld", PS(cache_expire) * 60, PS(cache_expire) * 60); /* SAFE */
        ADD_HEADER(buf);
 
        last_modified(TSRMLS_C);
}
 
CACHE_LIMITER_FUNC(private)
{
        ADD_HEADER("Expires: Thu, 19 Nov 1981 08:52:00 GMT");
        CACHE_LIMITER(private_no_expire)(TSRMLS_C);
}
 
CACHE_LIMITER_FUNC(nocache)
{
        ADD_HEADER("Expires: Thu, 19 Nov 1981 08:52:00 GMT");
        /* For HTTP/1.1 conforming clients and the rest (MSIE 5) */
        ADD_HEADER("Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
        /* For HTTP/1.0 conforming clients */
        ADD_HEADER("Pragma: no-cache");
}
 
static php_session_cache_limiter_t php_session_cache_limiters[] = {
        CACHE_LIMITER_ENTRY(public)
        CACHE_LIMITER_ENTRY(private)
        CACHE_LIMITER_ENTRY(private_no_expire)
        CACHE_LIMITER_ENTRY(nocache)
        {0}
};
 
static int php_session_cache_limiter(TSRMLS_D)
{
        php_session_cache_limiter_t *lim;
 
        if (PS(cache_limiter)[0] == '\0') return 0;
 
        if (SG(headers_sent)) {
                char *output_start_filename = php_get_output_start_filename(TSRMLS_C);
                int output_start_lineno = php_get_output_start_lineno(TSRMLS_C);
 
                if (output_start_filename) {
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Cannot send session cache limiter - headers already sent (output started at %s:%d)",
                                output_start_filename, output_start_lineno);
                } else {
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Cannot send session cache limiter - headers already sent");
                }
                return -2;
        }
 
        for (lim = php_session_cache_limiters; lim->name; lim++) {
                if (!strcasecmp(lim->name, PS(cache_limiter))) {
                        lim->func(TSRMLS_C);
                        return 0;
                }
        }
 
        return -1;
}

static void php_session_send_cookie(TSRMLS_D)
{
        smart_str ncookie = {0};
        char *date_fmt = NULL;
        char *e_session_name, *e_id;
 
        if (SG(headers_sent)) {
                char *output_start_filename = php_get_output_start_filename(TSRMLS_C);
                int output_start_lineno = php_get_output_start_lineno(TSRMLS_C);
 
                if (output_start_filename) {
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Cannot send session cookie - headers already sent by (output started at %s:%d)",
                                output_start_filename, output_start_lineno);
                } else {
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Cannot send session cookie - headers already sent");
                }
                return;
        }
 
        /* URL encode session_name and id because they might be user supplied */
        e_session_name = php_url_encode(PS(session_name), strlen(PS(session_name)), NULL);
        e_id = php_url_encode(PS(id), strlen(PS(id)), NULL);
 
        smart_str_appends(&ncookie, COOKIE_SET_COOKIE);
        smart_str_appends(&ncookie, e_session_name);
        smart_str_appendc(&ncookie, '=');
        smart_str_appends(&ncookie, e_id);
 
        efree(e_session_name);
        efree(e_id);
 
        if (PS(cookie_lifetime) > 0) {
                struct timeval tv;
                time_t t;
 
                gettimeofday(&tv, NULL);
                t = tv.tv_sec + PS(cookie_lifetime);
 
                if (t > 0) {
                        date_fmt = php_std_date(t TSRMLS_CC);
                        smart_str_appends(&ncookie, COOKIE_EXPIRES);
                        smart_str_appends(&ncookie, date_fmt);
                        efree(date_fmt);
                }
        }
 
        if (PS(cookie_path)[0]) {
                smart_str_appends(&ncookie, COOKIE_PATH);
                smart_str_appends(&ncookie, PS(cookie_path));
        }
 
        if (PS(cookie_domain)[0]) {
                smart_str_appends(&ncookie, COOKIE_DOMAIN);
                smart_str_appends(&ncookie, PS(cookie_domain));
        }
 
        if (PS(cookie_secure)) {
                smart_str_appends(&ncookie, COOKIE_SECURE);
        }
 
        if (PS(cookie_httponly)) {
                smart_str_appends(&ncookie, COOKIE_HTTPONLY);
        }
 
        smart_str_0(&ncookie);
 
        /*      'replace' must be 0 here, else a previous Set-Cookie
                header, probably sent with setcookie() will be replaced! */
        sapi_add_header_ex(ncookie.c, ncookie.len, 0, 0 TSRMLS_CC);
}

PHP Session File Hacks originally appeared on AskApache.com