<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>BrlAPI: Entering & leaving tty mode</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Entering & leaving tty mode</h1>How to take control of ttys for direct braille display / read.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__tty.html#ge0b2c127d52bada693a0e87a0ba42cda">BRLAPI_TTY_DEFAULT</a> -1</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode</a> (int tty, const char *driver)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__tty.html#g756e26827f24055afb1716cb6bc00d14">brlapi__enterTtyMode</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, int tty, const char *driver)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__tty.html#g4974c67da6fd48373fb2632298c25e70">brlapi_enterTtyModeWithPath</a> (int *ttys, int count, const char *driver)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__tty.html#g44f47193203aaa71b8e8959587e3bdb3">brlapi__enterTtyModeWithPath</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, int *ttys, int count, const char *driver)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__tty.html#g681f2c7f09e33a32a2731e4e77ce7cec">brlapi_leaveTtyMode</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__tty.html#gb9d34785c372717f567234ecae78809d">brlapi__leaveTtyMode</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__tty.html#g404a4af6b41cdacfb33fbbb09c1ce961">brlapi_setFocus</a> (int tty)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__tty.html#gd02a955f6bb02723e907f93cbef2616b">brlapi__setFocus</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, int tty)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Before being able to write on the braille display, the application must tell the server which tty it will handle.<p>
The application must also specify how braille keys will be delivered to it. Two ways are possible: key codes and commands:<p>
<ul>
<li>key codes are specific to each braille driver, since the raw key code, as defined in the driver will be given for each key press. Using them leads to building highly driver-dependent applications, which can yet sometimes be useful to mimic existing proprietary applications for instance.</li><li>commands means that applications will get exactly the same values as <em>brltty</em>. This allows driver-independent clients, which will hopefully be nice to use with a lot of different terminals. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey()</a> </dd></dl>
</li></ul>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="ge0b2c127d52bada693a0e87a0ba42cda"></a><!-- doxytag: member="brlapi.h::BRLAPI_TTY_DEFAULT" ref="ge0b2c127d52bada693a0e87a0ba42cda" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_TTY_DEFAULT -1 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Select the default tty.<p>
The library takes the following steps:<ol type=1>
<li>Try to get the tty number from the <code>WINDOWID</code> environment variable (for the <code>xterm</code> case).</li><li>Try to get the tty number from the <code>CONTROLVT</code> environment variable.</li><li>Read <code>/proc/self/stat</code> (on <code>Linux</code>).</li></ol>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a> </dd></dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g756e26827f24055afb1716cb6bc00d14"></a><!-- doxytag: member="brlapi.h::brlapi__enterTtyMode" ref="g756e26827f24055afb1716cb6bc00d14" args="(brlapi_handle_t *handle, int tty, const char *driver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__enterTtyMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tty</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>driver</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g44f47193203aaa71b8e8959587e3bdb3"></a><!-- doxytag: member="brlapi.h::brlapi__enterTtyModeWithPath" ref="g44f47193203aaa71b8e8959587e3bdb3" args="(brlapi_handle_t *handle, int *ttys, int count, const char *driver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__enterTtyModeWithPath </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>ttys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>driver</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="gb9d34785c372717f567234ecae78809d"></a><!-- doxytag: member="brlapi.h::brlapi__leaveTtyMode" ref="gb9d34785c372717f567234ecae78809d" args="(brlapi_handle_t *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__leaveTtyMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="gd02a955f6bb02723e907f93cbef2616b"></a><!-- doxytag: member="brlapi.h::brlapi__setFocus" ref="gd02a955f6bb02723e907f93cbef2616b" args="(brlapi_handle_t *handle, int tty)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__setFocus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tty</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g6d8ae822fa87d9bfb1fb15ecf2bbcaac"></a><!-- doxytag: member="brlapi.h::brlapi_enterTtyMode" ref="g6d8ae822fa87d9bfb1fb15ecf2bbcaac" args="(int tty, const char *driver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_enterTtyMode </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tty</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>driver</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ask for some tty, with some key mechanism<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tty</em> </td><td><ul>
<li>If tty>=0 then take control of the specified tty.</li><li>If tty==<a class="el" href="group__brlapi__tty.html#ge0b2c127d52bada693a0e87a0ba42cda">BRLAPI_TTY_DEFAULT</a> then take control of the default tty.</li></ul>
</td></tr>
<tr><td valign="top"></td><td valign="top"><em>driver</em> </td><td>tells how the application wants <a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey()</a> to return key presses. NULL or "" means BRLTTY commands are required, whereas a driver name means that raw key codes returned by this driver are expected.</td></tr>
</table>
</dl>
WINDOWPATH and WINDOWID should be propagated when running remote applications via ssh, for instance, along with BRLAPI_HOST and the authorization key (see SendEnv in ssh_config(5) and AcceptEnv in sshd_config(5))<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the used tty number on success, -1 on error</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__brlapi__tty.html#g681f2c7f09e33a32a2731e4e77ce7cec">brlapi_leaveTtyMode()</a> <a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g4974c67da6fd48373fb2632298c25e70"></a><!-- doxytag: member="brlapi.h::brlapi_enterTtyModeWithPath" ref="g4974c67da6fd48373fb2632298c25e70" args="(int *ttys, int count, const char *driver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_enterTtyModeWithPath </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>ttys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>driver</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ask for some tty specified by its path in the tty tree, with some key mechanism<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ttys</em> </td><td>points on the array of ttys representing the tty path to be got. Can be NULL if nttys is 0. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>gives the number of elements in ttys. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>driver</em> </td><td>has the same meaning as in <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a></td></tr>
</table>
</dl>
Providing nttys == 0 means to get the root.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g681f2c7f09e33a32a2731e4e77ce7cec"></a><!-- doxytag: member="brlapi.h::brlapi_leaveTtyMode" ref="g681f2c7f09e33a32a2731e4e77ce7cec" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_leaveTtyMode </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop controlling the tty<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g404a4af6b41cdacfb33fbbb09c1ce961"></a><!-- doxytag: member="brlapi.h::brlapi_setFocus" ref="g404a4af6b41cdacfb33fbbb09c1ce961" args="(int tty)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_setFocus </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tty</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tell the current tty to brltty<p>
This is intended for focus tellers, such as brltty, xbrlapi, screen, ... <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a> must have been called beforehand to tell where this focus applies in the tty tree.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a> <a class="el" href="group__brlapi__tty.html#g681f2c7f09e33a32a2731e4e77ce7cec">brlapi_leaveTtyMode()</a> </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 22:37:56 2009 for BrlAPI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
78cff6a8ec39f0e621e35b5f5c351f9d
>
files
>
49
