diff options
Diffstat (limited to 'payloads/libpayload/curses/PDCurses/doc/x11.txt')
| -rw-r--r-- | payloads/libpayload/curses/PDCurses/doc/x11.txt | 104 |
1 files changed, 52 insertions, 52 deletions
diff --git a/payloads/libpayload/curses/PDCurses/doc/x11.txt b/payloads/libpayload/curses/PDCurses/doc/x11.txt index db05683d17..5b5cfc0fe1 100644 --- a/payloads/libpayload/curses/PDCurses/doc/x11.txt +++ b/payloads/libpayload/curses/PDCurses/doc/x11.txt @@ -1,35 +1,35 @@ X11 Considerations ================== -PDCurses for X11 uses the System V IPC shared memory facility, along -with sockets, to share data between the curses program and the child +PDCurses for X11 uses the System V IPC shared memory facility, along +with sockets, to share data between the curses program and the child process created to manage the X stuff. -When compiling your application, you need to include the <curses.h> or -<xcurses.h> that comes with PDCurses. You also need to link your code -with libXCurses. You may need to link with the following libraries under +When compiling your application, you need to include the <curses.h> or +<xcurses.h> that comes with PDCurses. You also need to link your code +with libXCurses. You may need to link with the following libraries under X11R5: Xaw Xmu Xt X11 or, under X11R6: Xaw Xmu Xt X11 SM ICE Xext -You can run "xcurses-config --libs" to show the link parameters for your +You can run "xcurses-config --libs" to show the link parameters for your system. If using dynamic linking, on some systems, "-lXCurses" suffices. -By calling Xinitscr() rather than initscr(), you can pass your program -name and resource overrides to PDCurses. The program name is used as the -title of the X window, and for defining X resources specific to your +By calling Xinitscr() rather than initscr(), you can pass your program +name and resource overrides to PDCurses. The program name is used as the +title of the X window, and for defining X resources specific to your program. Interaction with stdio ---------------------- -Be aware that curses programs that expect to have a normal tty -underneath them will be very disappointed! Output directed to stdout -will go to the xterm that invoked the PDCurses application, or to the -console if not invoked directly from an xterm. Similarly, stdin will +Be aware that curses programs that expect to have a normal tty +underneath them will be very disappointed! Output directed to stdout +will go to the xterm that invoked the PDCurses application, or to the +console if not invoked directly from an xterm. Similarly, stdin will expect its input from the same place as stdout. @@ -89,7 +89,7 @@ normalFont: The name of a fixed width font. Default: 7x13 italicFont: The name of a fixed width font to be used for - characters with A_ITALIC attributes. Must have the + characters with A_ITALIC attributes. Must have the same cell size as normalFont. Default: 7x13 (obviously not an italic font) @@ -155,14 +155,14 @@ colorBoldWhite: COLOR_WHITE combined with A_BOLD. bitmap: The name of a valid bitmap file of depth 1 (black and white) used for the application's icon. The file is an X bitmap. - Default: a 32x32 or 64x64 pixmap depending on the + Default: a 32x32 or 64x64 pixmap depending on the window manager -pixmap: The name of a valid pixmap file of any depth - supported by the window manager (color) for the - application's icon, The file is an X11 pixmap. This - resource is only available if the libXpm package has - been installed (most systems have this by default). +pixmap: The name of a valid pixmap file of any depth + supported by the window manager (color) for the + application's icon, The file is an X11 pixmap. This + resource is only available if the libXpm package has + been installed (most systems have this by default). This resource overrides the "bitmap" resource. Default: none, uses default bitmap above @@ -177,28 +177,28 @@ translations: Translations enable the user to customize the action <BtnUp>: XCursesButton() <BtnMotion>: XCursesButton() - The most useful action for KeyPress translations is - string(). The argument to the string() action can be - either a string or a hex representation of a + The most useful action for KeyPress translations is + string(). The argument to the string() action can be + either a string or a hex representation of a character; e.g., string(0x1b) will send the ASCII - escape character to the application; string("[11~") + escape character to the application; string("[11~") will send [ 1 1 ~ , as separate keystrokes. shmmin: On most systems, there are two Unix kernel parameters that determine the allowable size of a shared memory - segment. These parameters are usually something like + segment. These parameters are usually something like SHMMIN and SHMMAX. To use shared memory, a program must allocate a segment of shared memory that is between these two values. Usually these values are - like 1 for SHMMIN and some large number for SHMMAX. + like 1 for SHMMIN and some large number for SHMMAX. Sometimes the Unix kernel is configured to have a value of SHMMIN that is bigger than the size of one - of the shared memory segments that libXCurses uses. + of the shared memory segments that libXCurses uses. On these systems an error message like: Cannot allocate shared memory for SCREEN: Invalid argument - will result. To overcome this problem, this resource + will result. To overcome this problem, this resource should be set to the kernel value for SHMMIN. This ensures that a shared memory segment will always be bigger than the kernel value for SHMMIN (and @@ -212,7 +212,7 @@ borderColor: The color of the border around the screen. borderWidth: The width in pixels of the border around the screen. Default: 0 -clickPeriod: The period (in milliseconds) between a button +clickPeriod: The period (in milliseconds) between a button press and a button release that determines if a click of a button has occurred. Default: 100 @@ -223,10 +223,10 @@ doubleClickPeriod: The period (in milliseconds) between two button Default: 200 composeKey: The name of the X key that defines the "compose key", - which is used to enter characters in the Latin-1 - character set above 0xA0. (See "Compose Keys for - Latin-1" below.) This is used only when PDCurses is - built without XIM support. While in compose mode, the + which is used to enter characters in the Latin-1 + character set above 0xA0. (See "Compose Keys for + Latin-1" below.) This is used only when PDCurses is + built without XIM support. While in compose mode, the text cursor will appear as a hollow rectangle. Default: Multi_key @@ -234,8 +234,8 @@ composeKey: The name of the X key that defines the "compose key", Using Resources --------------- -All applications have a top-level class name of "XCurses". If Xinitscr() -is used, it sets an application's top-level widget name. (Otherwise the +All applications have a top-level class name of "XCurses". If Xinitscr() +is used, it sets an application's top-level widget name. (Otherwise the name defaults to "PDCurses".) Examples for app-defaults or .Xdefaults: @@ -275,26 +275,26 @@ the*pointerBackColor: black the.bitmap: /home/mark/the/the64.xbm the.pixmap: /home/mark/the/the64.xpm -Resources may also be passed as parameters to the Xinitscr() function. -Parameters are strings in the form of switches; e.g., to set the color -"red" to "indianred", and the number of lines to 30, the string passed +Resources may also be passed as parameters to the Xinitscr() function. +Parameters are strings in the form of switches; e.g., to set the color +"red" to "indianred", and the number of lines to 30, the string passed to Xinitscr would be: "-colorRed indianred -lines 30" Compose Keys for Latin-1 ------------------------ -When built without XIM support, PDCurses for X11 provides its own, -limited compose key system for Latin-1 characters. The available -combinations are listed here. For a given character, any of the -combinations shown in the last column may be used. To generate a -character, press the "compose" key followed by one of the pairs of -keystrokes. Where no key is evident, the spacebar is used. Thus, to -generate the NO-BREAK SPACE, press the "compose" key followed by two +When built without XIM support, PDCurses for X11 provides its own, +limited compose key system for Latin-1 characters. The available +combinations are listed here. For a given character, any of the +combinations shown in the last column may be used. To generate a +character, press the "compose" key followed by one of the pairs of +keystrokes. Where no key is evident, the spacebar is used. Thus, to +generate the NO-BREAK SPACE, press the "compose" key followed by two hits of the spacebar. -With a typical modern X server, you can get many more compose key -combinations by using XIM instead. Configure PDCurses with --enable-xim +With a typical modern X server, you can get many more compose key +combinations by using XIM instead. Configure PDCurses with --enable-xim to use XIM support. This document is encoded in UTF-8. @@ -404,13 +404,13 @@ This document is encoded in UTF-8. Deprecated ---------- -XCursesProgramName is no longer used. To set the program name, you must +XCursesProgramName is no longer used. To set the program name, you must use Xinitscr(), or PDC_set_title() to set just the window title. -The XCursesExit() function is now called automatically via atexit(). -(Multiple calls to it are OK, so you don't need to remove it if you've +The XCursesExit() function is now called automatically via atexit(). +(Multiple calls to it are OK, so you don't need to remove it if you've already added it for previous versions of PDCurses.) -XCURSES is no longer defined automatically, but need not be defined, -unless you want the X11-specific prototypes. (Normal curses programs +XCURSES is no longer defined automatically, but need not be defined, +unless you want the X11-specific prototypes. (Normal curses programs won't need it.) |