diff --git a/reference/ncurses/constants.xml b/reference/ncurses/constants.xml new file mode 100644 index 0000000000..f1684b1e4f --- /dev/null +++ b/reference/ncurses/constants.xml @@ -0,0 +1,503 @@ + + +
+ &reftitle.constants; + &extension.constants; +
+ Error codes + + On error ncurses functions return NCURSES_ERR. + +
+
+ Colors + + ncurses color constants + + + + constant + meaning + + + + + NCURSES_COLOR_BLACK + no color (black) + + + NCURSES_COLOR_WHITE + white + + + NCURSES_COLOR_RED + red - supported when terminal is in color mode + + + NCURSES_COLOR_GREEN + green - supported when terminal is in color mod + + + NCURSES_COLOR_YELLOW + yellow - supported when terminal is in color mod + + + NCURSES_COLOR_BLUE + blue - supported when terminal is in color mod + + + NCURSES_COLOR_CYAN + cyan - supported when terminal is in color mod + + + NCURSES_COLOR_MAGENTA + magenta - supported when terminal is in color mod + + + +
+
+
+ Keys + + ncurses key constants + + + + constant + meaning + + + + + NCURSES_KEY_F0 - NCURSES_KEY_F64 + function keys F1 - F64 + + + NCURSES_KEY_DOWN + down arrow + + + NCURSES_KEY_UP + up arrow + + + NCURSES_KEY_LEFT + left arrow + + + NCURSES_KEY_RIGHT + right arrow + + + NCURSES_KEY_HOME + home key (upward+left arrow) + + + NCURSES_KEY_BACKSPACE + backspace + + + NCURSES_KEY_DL + delete line + + + NCURSES_KEY_IL + insert line + + + NCURSES_KEY_DC + delete character + + + NCURSES_KEY_IC + insert char or enter insert mode + + + NCURSES_KEY_EIC + exit insert char mode + + + NCURSES_KEY_CLEAR + clear screen + + + NCURSES_KEY_EOS + clear to end of screen + + + NCURSES_KEY_EOL + clear to end of line + + + NCURSES_KEY_SF + scroll one line forward + + + NCURSES_KEY_SR + scroll one line backward + + + NCURSES_KEY_NPAGE + next page + + + NCURSES_KEY_PPAGE + previous page + + + NCURSES_KEY_STAB + set tab + + + NCURSES_KEY_CTAB + clear tab + + + NCURSES_KEY_CATAB + clear all tabs + + + NCURSES_KEY_SRESET + soft (partial) reset + + + NCURSES_KEY_RESET + reset or hard reset + + + NCURSES_KEY_PRINT + print + + + NCURSES_KEY_LL + lower left + + + NCURSES_KEY_A1 + upper left of keypad + + + NCURSES_KEY_A3 + upper right of keypad + + + NCURSES_KEY_B2 + center of keypad + + + NCURSES_KEY_C1 + lower left of keypad + + + NCURSES_KEY_C3 + lower right of keypad + + + NCURSES_KEY_BTAB + back tab + + + NCURSES_KEY_BEG + beginning + + + NCURSES_KEY_CANCEL + cancel + + + NCURSES_KEY_CLOSE + close + + + NCURSES_KEY_COMMAND + cmd (command) + + + NCURSES_KEY_COPY + copy + + + NCURSES_KEY_CREATE + create + + + NCURSES_KEY_END + end + + + NCURSES_KEY_EXIT + exit + + + NCURSES_KEY_FIND + find + + + NCURSES_KEY_HELP + help + + + NCURSES_KEY_MARK + mark + + + NCURSES_KEY_MESSAGE + message + + + NCURSES_KEY_MOVE + move + + + NCURSES_KEY_NEXT + next + + + NCURSES_KEY_OPEN + open + + + NCURSES_KEY_OPTIONS + options + + + NCURSES_KEY_PREVIOUS + previous + + + NCURSES_KEY_REDO + redo + + + NCURSES_KEY_REFERENCE + ref (reference) + + + NCURSES_KEY_REFRESH + refresh + + + NCURSES_KEY_REPLACE + replace + + + NCURSES_KEY_RESTART + restart + + + NCURSES_KEY_RESUME + resume + + + NCURSES_KEY_SAVE + save + + + NCURSES_KEY_SBEG + shiftet beg (beginning) + + + NCURSES_KEY_SCANCEL + shifted cancel + + + NCURSES_KEY_SCOMMAND + shifted command + + + NCURSES_KEY_SCOPY + shifted copy + + + NCURSES_KEY_SCREATE + shifted create + + + NCURSES_KEY_SDC + shifted delete char + + + NCURSES_KEY_SDL + shifted delete line + + + NCURSES_KEY_SELECT + select + + + NCURSES_KEY_SEND + shifted end + + + NCURSES_KEY_SEOL + shifted end of line + + + NCURSES_KEY_SEXIT + shifted exit + + + NCURSES_KEY_SFIND + shifted find + + + NCURSES_KEY_SHELP + shifted help + + + NCURSES_KEY_SHOME + shifted home + + + NCURSES_KEY_SIC + shifted input + + + NCURSES_KEY_SLEFT + shifted left arrow + + + NCURSES_KEY_SMESSAGE + shifted message + + + NCURSES_KEY_SMOVE + shifted move + + + NCURSES_KEY_SNEXT + shifted next + + + NCURSES_KEY_SOPTIONS + shifted options + + + NCURSES_KEY_SPREVIOUS + shifted previous + + + NCURSES_KEY_SPRINT + shifted print + + + NCURSES_KEY_SREDO + shifted redo + + + NCURSES_KEY_SREPLACE + shifted replace + + + NCURSES_KEY_SRIGHT + shifted right arrow + + + NCURSES_KEY_SRSUME + shifted resume + + + NCURSES_KEY_SSAVE + shifted save + + + NCURSES_KEY_SSUSPEND + shifted suspend + + + NCURSES_KEY_UNDO + undo + + + NCURSES_KEY_MOUSE + mouse event has occured + + + NCURSES_KEY_MAX + maximum key value + + + +
+
+
+ Mouse + + mouse constants + + + + Constant + meaning + + + + + NCURSES_BUTTON1_RELEASED - NCURSES_BUTTON4_RELEASED + button (1-4) released + + + NCURSES_BUTTON1_PRESSED - NCURSES_BUTTON4_PRESSED + button (1-4) pressed + + + NCURSES_BUTTON1_CLICKED - NCURSES_BUTTON4_CLICKED + button (1-4) clicked + + + NCURSES_BUTTON1_DOUBLE_CLICKED - + NCURSES_BUTTON4_DOUBLE_CLICKED + button (1-4) double clicked + + + NCURSES_BUTTON1_TRIPLE_CLICKED - + NCURSES_BUTTON4_TRIPLE_CLICKED + button (1-4) triple clicked + + + NCURSES_BUTTON_CTRL + ctrl pressed during click + + + NCURSES_BUTTON_SHIFT + shift pressed during click + + + NCURSES_BUTTON_ALT + alt pressed during click + + + NCURSES_ALL_MOUSE_EVENTS + report all mouse events + + + NCURSES_REPORT_MOUSE_POSITION + report mouse position + + + +
+
+
+ + diff --git a/reference/ncurses/reference.xml b/reference/ncurses/reference.xml index e618ef98cd..549486d0e5 100644 --- a/reference/ncurses/reference.xml +++ b/reference/ncurses/reference.xml @@ -1,22 +1,18 @@ - + Ncurses terminal screen control functions ncurses functions - &warn.experimental; -
- What is ncurses? + &reftitle.intro; ncurses (new curses) is a free software emulation of curses in - System V Rel 4.0 (and above). It uses terminfo format, supports pads, colors, multiple - highlights, form characters and function key mapping. + System V Rel 4.0 (and above). It uses terminfo format, supports pads, + colors, multiple highlights, form characters and function key mapping. -
-
- Platforms + &warn.experimental; Ncurses is available for the following platforms: @@ -35,506 +31,43 @@
+
- Requirements + &reftitle.required; You need the ncurses libraries and headerfiles. Download the - latest version from the &url.ncurses; or from an other GNU-Mirror. + latest version from the &url.ncurses; + or from an other GNU-Mirror.
+
- Installation + &reftitle.install; To get these functions to work, you have to compile the CGI version of PHP with .
-
- Ncurses predefined constants -
- Error codes - - On error ncurses functions return NCURSES_ERR. - -
-
- Colors - - ncurses color constants - - - - constant - meaning - - - - - NCURSES_COLOR_BLACK - no color (black) - - - NCURSES_COLOR_WHITE - white - - - NCURSES_COLOR_RED - red - supported when terminal is in color mode - - - NCURSES_COLOR_GREEN - green - supported when terminal is in color mod - - - NCURSES_COLOR_YELLOW - yellow - supported when terminal is in color mod - - - NCURSES_COLOR_BLUE - blue - supported when terminal is in color mod - - - NCURSES_COLOR_CYAN - cyan - supported when terminal is in color mod - - - NCURSES_COLOR_MAGENTA - magenta - supported when terminal is in color mod - - - -
-
-
- Keys - - ncurses key constants - - - - constant - meaning - - - - - NCURSES_KEY_F0 - NCURSES_KEY_F64 - function keys F1 - F64 - - - NCURSES_KEY_DOWN - down arrow - - - NCURSES_KEY_UP - up arrow - - - NCURSES_KEY_LEFT - left arrow - - - NCURSES_KEY_RIGHT - right arrow - - - NCURSES_KEY_HOME - home key (upward+left arrow) - - - NCURSES_KEY_BACKSPACE - backspace - - - NCURSES_KEY_DL - delete line - - - NCURSES_KEY_IL - insert line - - - NCURSES_KEY_DC - delete character - - - NCURSES_KEY_IC - insert char or enter insert mode - - - NCURSES_KEY_EIC - exit insert char mode - - - NCURSES_KEY_CLEAR - clear screen - - - NCURSES_KEY_EOS - clear to end of screen - - - NCURSES_KEY_EOL - clear to end of line - - - NCURSES_KEY_SF - scroll one line forward - - - NCURSES_KEY_SR - scroll one line backward - - - NCURSES_KEY_NPAGE - next page - - - NCURSES_KEY_PPAGE - previous page - - - NCURSES_KEY_STAB - set tab - - - NCURSES_KEY_CTAB - clear tab - - - NCURSES_KEY_CATAB - clear all tabs - - - NCURSES_KEY_SRESET - soft (partial) reset - - - NCURSES_KEY_RESET - reset or hard reset - - - NCURSES_KEY_PRINT - print - - - NCURSES_KEY_LL - lower left - - - NCURSES_KEY_A1 - upper left of keypad - - - NCURSES_KEY_A3 - upper right of keypad - - - NCURSES_KEY_B2 - center of keypad - - - NCURSES_KEY_C1 - lower left of keypad - - - NCURSES_KEY_C3 - lower right of keypad - - - NCURSES_KEY_BTAB - back tab - - - NCURSES_KEY_BEG - beginning - - - NCURSES_KEY_CANCEL - cancel - - - NCURSES_KEY_CLOSE - close - - - NCURSES_KEY_COMMAND - cmd (command) - - - NCURSES_KEY_COPY - copy - - - NCURSES_KEY_CREATE - create - - - NCURSES_KEY_END - end - - - NCURSES_KEY_EXIT - exit - - - NCURSES_KEY_FIND - find - - - NCURSES_KEY_HELP - help - - - NCURSES_KEY_MARK - mark - - - NCURSES_KEY_MESSAGE - message - - - NCURSES_KEY_MOVE - move - - - NCURSES_KEY_NEXT - next - - - NCURSES_KEY_OPEN - open - - - NCURSES_KEY_OPTIONS - options - - - NCURSES_KEY_PREVIOUS - previous - - - NCURSES_KEY_REDO - redo - - - NCURSES_KEY_REFERENCE - ref (reference) - - - NCURSES_KEY_REFRESH - refresh - - - NCURSES_KEY_REPLACE - replace - - - NCURSES_KEY_RESTART - restart - - - NCURSES_KEY_RESUME - resume - - - NCURSES_KEY_SAVE - save - - - NCURSES_KEY_SBEG - shiftet beg (beginning) - - - NCURSES_KEY_SCANCEL - shifted cancel - - - NCURSES_KEY_SCOMMAND - shifted command - - - NCURSES_KEY_SCOPY - shifted copy - - - NCURSES_KEY_SCREATE - shifted create - - - NCURSES_KEY_SDC - shifted delete char - - - NCURSES_KEY_SDL - shifted delete line - - - NCURSES_KEY_SELECT - select - - - NCURSES_KEY_SEND - shifted end - - - NCURSES_KEY_SEOL - shifted end of line - - - NCURSES_KEY_SEXIT - shifted exit - - - NCURSES_KEY_SFIND - shifted find - - - NCURSES_KEY_SHELP - shifted help - - - NCURSES_KEY_SHOME - shifted home - - - NCURSES_KEY_SIC - shifted input - - - NCURSES_KEY_SLEFT - shifted left arrow - - - NCURSES_KEY_SMESSAGE - shifted message - - - NCURSES_KEY_SMOVE - shifted move - - - NCURSES_KEY_SNEXT - shifted next - - - NCURSES_KEY_SOPTIONS - shifted options - - - NCURSES_KEY_SPREVIOUS - shifted previous - - - NCURSES_KEY_SPRINT - shifted print - - - NCURSES_KEY_SREDO - shifted redo - - - NCURSES_KEY_SREPLACE - shifted replace - - - NCURSES_KEY_SRIGHT - shifted right arrow - - - NCURSES_KEY_SRSUME - shifted resume - - - NCURSES_KEY_SSAVE - shifted save - - - NCURSES_KEY_SSUSPEND - shifted suspend - - - NCURSES_KEY_UNDO - undo - - - NCURSES_KEY_MOUSE - mouse event has occured - - - NCURSES_KEY_MAX - maximum key value - - - -
-
-
- Mouse - - mouse constants - - - - Constant - meaning - - - - - NCURSES_BUTTON1_RELEASED - NCURSES_BUTTON4_RELEASED - button (1-4) released - - - NCURSES_BUTTON1_PRESSED - NCURSES_BUTTON4_PRESSED - button (1-4) pressed - - - NCURSES_BUTTON1_CLICKED - NCURSES_BUTTON4_CLICKED - button (1-4) clicked - - - NCURSES_BUTTON1_DOUBLE_CLICKED - - NCURSES_BUTTON4_DOUBLE_CLICKED - button (1-4) double clicked - - - NCURSES_BUTTON1_TRIPLE_CLICKED - - NCURSES_BUTTON4_TRIPLE_CLICKED - button (1-4) triple clicked - - - NCURSES_BUTTON_CTRL - ctrl pressed during click - - - NCURSES_BUTTON_SHIFT - shift pressed during click - - - NCURSES_BUTTON_ALT - alt pressed during click - - - NCURSES_ALL_MOUSE_EVENTS - report all mouse events - - - NCURSES_REPORT_MOUSE_POSITION - report mouse position - - - -
-
-
- + +
+ &reftitle.runtime; + &no.config; +
+ +
+ &reftitle.resources; + &no.resource; +
+ + &reference.ncurses.constants; + + &reference.ncurses.functions; + +
+ &reftitle.constants; + &extension.constants.core; + + <function>openlog</function> Options + + + + Constant + Description + + + + + LOG_CONS + + if there is an error while sending data to the system logger, + write directly to the system console + + + + LOG_NDELAY + + open the connection to the logger immediately + + + + LOG_ODELAY + + (default) delay opening the connection until the first + message is logged + + + + LOG_PERROR + print log message also to standard error + + + LOG_PID + include PID with each message + + + +
+ + <function>syslog</function> Priorities (in descending order) + + + + Constant + Description + + + + + LOG_EMERG + system is unusable + + + LOG_ALERT + action must be taken immediately + + + LOG_CRIT + critical conditions + + + LOG_ERR + error conditions + + + LOG_WARNING + warning conditions + + + LOG_NOTICE + normal, but significant, condition + + + LOG_INFO + informational message + + + LOG_DEBUG + debug-level message + + + +
+
+ + diff --git a/reference/network/reference.xml b/reference/network/reference.xml index 8c3fb2ab85..b058b14a5a 100644 --- a/reference/network/reference.xml +++ b/reference/network/reference.xml @@ -1,8 +1,40 @@ - + Network Functions Network + + +
+ &reftitle.intro; + + + +
+ +
+ &reftitle.required; + &no.requirement; +
+ +
+ &reftitle.install; + &no.install; +
+ +
+ &reftitle.runtime; + &no.config; +
+ +
+ &reftitle.resources; + &no.resource; +
+ + &reference.network.constants; + + &reference.network.functions;