diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/tput.1.html')
| -rw-r--r-- | ncurses-5.2/doc/html/man/tput.1.html | 246 |
1 files changed, 0 insertions, 246 deletions
diff --git a/ncurses-5.2/doc/html/man/tput.1.html b/ncurses-5.2/doc/html/man/tput.1.html deleted file mode 100644 index 17c55aa..0000000 --- a/ncurses-5.2/doc/html/man/tput.1.html +++ /dev/null @@ -1,246 +0,0 @@ -<HTML> -<BODY> -<PRE> -<!-- Manpage converted by man2html 3.0.1 --> - -</PRE> -<H2>NAME</H2><PRE> - <B>tput</B>, <B>reset</B> - initialize a terminal or query terminfo - database - - -</PRE> -<H2>SYNOPSIS</H2><PRE> - <B>tput</B> [<B>-T</B><I>type</I>] <I>capname</I> [<I>parms</I> ... ] - <B>tput</B> [<B>-T</B><I>type</I>] <B>init</B> - <B>tput</B> [<B>-T</B><I>type</I>] <B>reset</B> - <B>tput</B> [<B>-T</B><I>type</I>] <B>longname</B> - <B>tput</B> <B>-S</B> <B><<</B> - <B>tput</B> <B>-V</B> - - -</PRE> -<H2>DESCRIPTION</H2><PRE> - The <B>tput</B> utility uses the <B>terminfo</B> database to make the - values of terminal-dependent capabilities and information - available to the shell (see <B><A HREF="sh.1.html">sh(1)</A></B>), to initialize or reset - the terminal, or return the long name of the requested - terminal type. <B>tput</B> outputs a string if the attribute - (<I>cap</I>ability <I>name</I>) is of type string, or an integer if the - attribute is of type integer. If the attribute is of type - boolean, <B>tput</B> simply sets the exit code (<B>0</B> for TRUE if the - terminal has the capability, <B>1</B> for FALSE if it does not), - and produces no output. Before using a value returned on - standard output, the user should test the exit code [<B>$?</B>, - see <B><A HREF="sh.1.html">sh(1)</A></B>] to be sure it is <B>0</B>. (See the <B>EXIT</B> <B>CODES</B> and - <B>DIAGNOSTICS</B> sections.) For a complete list of capabili- - ties and the <I>capname</I> associated with each, see <B>ter-</B> - <B><A HREF="minfo.5.html">minfo(5)</A></B>. - - <B>-T</B><I>type</I> indicates the <I>type</I> of terminal. Normally this - option is unnecessary, because the default is taken - from the environment variable <B>TERM</B>. If <B>-T</B> is spec- - ified, then the shell variables <B>LINES</B> and <B>COLUMNS</B> - will be ignored,and the operating system will not - be queried for the actual screen size. - - <I>capname</I> - indicates the attribute from the <B>terminfo</B> database. - When <B>termcap</B> support is compiled in, the <B>termcap</B> - name for the attribute is also accepted. - - <I>parms</I> If the attribute is a string that takes parameters, - the arguments <I>parms</I> will be instantiated into the - string. An all numeric argument will be passed to - the attribute as a number. - - <B>-S</B> allows more than one capability per invocation of - <B>tput</B>. The capabilities must be passed to <B>tput</B> from - the standard input instead of from the command line - (see example). Only one <I>capname</I> is allowed per - line. The <B>-S</B> option changes the meaning of the <B>0</B> - and <B>1</B> boolean and string exit codes (see the EXIT - CODES section). - - <B>-V</B> reports the version of ncurses which was used in - this program, and exits. - - <B>init</B> If the <B>terminfo</B> database is present and an entry - for the user's terminal exists (see <B>-T</B><I>type</I>, above), - the following will occur: (1) if present, the ter- - minal's initialization strings will be output (<B>is1</B>, - <B>is2</B>, <B>is3</B>, <B>if</B>, <B>iprog</B>), (2) any delays (e.g., new- - line) specified in the entry will be set in the tty - driver, (3) tabs expansion will be turned on or off - according to the specification in the entry, and - (4) if tabs are not expanded, standard tabs will be - set (every 8 spaces). If an entry does not contain - the information needed for any of the four above - activities, that activity will silently be skipped. - - <B>reset</B> Instead of putting out initialization strings, the - terminal's reset strings will be output if present - (<B>rs1</B>, <B>rs2</B>, <B>rs3</B>, <B>rf</B>). If the reset strings are not - present, but initialization strings are, the ini- - tialization strings will be output. Otherwise, - <B>reset</B> acts identically to <B>init</B>. - - <B>longname</B> - If the <B>terminfo</B> database is present and an entry - for the user's terminal exists (see <B>-T</B><I>type</I> above), - then the long name of the terminal will be put out. - The long name is the last name in the first line of - the terminal's description in the <B>terminfo</B> database - [see <B><A HREF="term.5.html">term(5)</A></B>]. - - If <B>tput</B> is invoked by a link named <B>reset</B>, this has the - same effect as <B>tput</B> <B>reset</B>. See <B>tset</B> for comparison, which - has similar behavior. - - -</PRE> -<H2>EXAMPLES</H2><PRE> - <B>tput</B> <B>init</B> - Initialize the terminal according to the type of ter- - minal in the environmental variable <B>TERM</B>. This com- - mand should be included in everyone's .profile after - the environmental variable <B>TERM</B> has been exported, as - illustrated on the <B><A HREF="profile.4.html">profile(4)</A></B> manual page. - - <B>tput</B> <B>-T5620</B> <B>reset</B> - Reset an AT&T 5620 terminal, overriding the type of - terminal in the environmental variable <B>TERM</B>. - - <B>tput</B> <B>cup</B> <B>0</B> <B>0</B> - Send the sequence to move the cursor to row <B>0</B>, column - <B>0</B> (the upper left corner of the screen, usually known - as the "home" cursor position). - - <B>tput</B> <B>clear</B> - Echo the clear-screen sequence for the current - terminal. - - <B>tput</B> <B>cols</B> - Print the number of columns for the current terminal. - - <B>tput</B> <B>-T450</B> <B>cols</B> - Print the number of columns for the 450 terminal. - - <B>bold=`tput</B> <B>smso`</B> <B>offbold=`tput</B> <B>rmso`</B> - Set the shell variables <B>bold</B>, to begin stand-out mode - sequence, and <B>offbold</B>, to end standout mode sequence, - for the current terminal. This might be followed by - a prompt: <B>echo</B> <B>"${bold}Please</B> <B>type</B> <B>in</B> <B>your</B> <B>name:</B> - <B>${offbold}\c"</B> - - <B>tput</B> <B>hc</B> - Set exit code to indicate if the current terminal is - a hard copy terminal. - - <B>tput</B> <B>cup</B> <B>23</B> <B>4</B> - Send the sequence to move the cursor to row 23, col- - umn 4. - - <B>tput</B> <B>longname</B> - Print the long name from the <B>terminfo</B> database for - the type of terminal specified in the environmental - variable <B>TERM</B>. - - <B>tput</B> <B>-S</B> <B><<!</B> - <B>></B> <B>clear</B> - <B>></B> <B>cup</B> <B>10</B> <B>10</B> - <B>></B> <B>bold</B> - <B>></B> <B>!</B> - - This example shows tput processing several capabili- - ties in one invocation. This example clears the - screen, moves the cursor to position 10, 10 and turns - on bold (extra bright) mode. The list is terminated - by an exclamation mark (<B>!</B>) on a line by itself. - - -</PRE> -<H2>FILES</H2><PRE> - <B>/usr/share/terminfo</B> - compiled terminal description database - - <B>/usr/include/curses.h</B> - <B><A HREF="ncurses.3x.html">curses(3x)</A></B> header file - - <B>/usr/include/term.h</B> - <B>terminfo</B> header file - - <B>/usr/share/tabset/*</B> - tab settings for some terminals, in a format appro- - priate to be output to the terminal (escape - sequences that set margins and tabs); for more - information, see the "Tabs and Initialization" sec- - tion of <B><A HREF="terminfo.4.html">terminfo(4)</A></B> - - -</PRE> -<H2>SEE ALSO</H2><PRE> - <B><A HREF="clear.1.html">clear(1)</A></B>, <B><A HREF="stty.1.html">stty(1)</A></B>, <B><A HREF="tabs.5.html">tabs(5)</A></B>. <B><A HREF="profile.5.html">profile(5)</A></B>, <B><A HREF="terminfo.4.html">terminfo(4)</A></B> in - the <I>System</I> <I>Administrator</I>'<I>s</I> <I>Reference</I> <I>Manual</I>. Chapter 10 - of the <I>Programmer</I>'<I>s</I> <I>Guide</I>. - - -</PRE> -<H2>EXIT CODES</H2><PRE> - If <I>capname</I> is of type boolean, a value of <B>0</B> is set for - TRUE and <B>1</B> for FALSE unless the <B>-S</B> option is used. - - If <I>capname</I> is of type string, a value of <B>0</B> is set if the - <I>capname</I> is defined for this terminal <I>type</I> (the value of - <I>capname</I> is returned on standard output); a value of <B>1</B> is - set if <I>capname</I> is not defined for this terminal <I>type</I> (a - null value is returned on standard output). - - If <I>capname</I> is of type boolean or string and the <B>-S</B> option - is used, a value of <B>0</B> is returned to indicate that all - lines were successful. No indication of which line failed - can be given so exit code <B>1</B> will never appear. Exit codes - <B>2</B>, <B>3</B>, and <B>4</B> retain their usual interpretation. - - If <I>capname</I> is of type integer, a value of <B>0</B> is always set, - whether or not <I>capname</I> is defined for this terminal <I>type</I>. - To determine if <I>capname</I> is defined for this terminal <I>type</I>, - the user must test the value of standard output. A value - of <B>-1</B> means that <I>capname</I> is not defined for this terminal - <I>type</I>. - - Any other exit code indicates an error; see the DIAGNOS- - TICS section. - - -</PRE> -<H2>DIAGNOSTICS</H2><PRE> - <B>tput</B> prints the following error messages and sets the cor- - responding exit codes. - - exit code error message - --------------------------------------------------------------------- - <B>0</B> (<I>capname</I> is a numeric variable that is not specified in - the <B><A HREF="terminfo.5.html">terminfo(5)</A></B> database for this terminal type, e.g. - <B>tput</B> <B>-T450</B> <B>lines</B> and <B>tput</B> <B>-T2621</B> <B>xmc</B>) - <B>1</B> no error message is printed, see the <B>EXIT</B> <B>CODES</B> section. - <B>2</B> usage error - <B>3</B> unknown terminal <I>type</I> or no <B>terminfo</B> database - <B>4</B> unknown <B>terminfo</B> capability <I>capname</I> - --------------------------------------------------------------------- - - -</PRE> -<H2>PORTABILITY</H2><PRE> - The <B>longname</B> and <B>-S</B> options, and the parameter-substitu- - tion features used in the <B>cup</B> example, are not supported - in BSD curses or in AT&T/USL curses before SVr4. - -</PRE> -<HR> -<ADDRESS> -Man(1) output converted with -<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> -</ADDRESS> -</BODY> -</HTML> |