rxvt-unicode/doc/rxvtc.1.html

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>rxvtc - control the rxvtd daemon</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:perl-binary@plan9.de" />
</head>

<body style="background-color: white">

<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->

<ul>

        <li><a href="#name">NAME</a></li>
        <li><a href="#synopsis">SYNOPSIS</a></li>
        <li><a href="#description">DESCRIPTION</a></li>
        <li><a href="#options">OPTIONS</a></li>
        <li><a href="#exit_status">EXIT STATUS</a></li>
        <li><a href="#environment">ENVIRONMENT</a></li>
        <li><a href="#see_also">SEE ALSO</a></li>
</ul>
<!-- INDEX END -->

<hr />
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>rxvtc - control the rxvtd daemon</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p><strong>rxvtc</strong> [same options as for rxvt]</p>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>This manpage describes the <strong>rxvtc</strong> client program. It connects
to the <strong>rxvtd</strong> daemon and requests a new terminal window. It
takes the same arguments as the <strong>rxvt</strong> program. The environment
will also be respected. Currently, it always returns immediately after
contacting the daemon.</p>
<p>
</p>
<hr />
<h1><a name="options">OPTIONS</a></h1>
<p>All options that are valid for <strong>rxvt</strong> are valid for
<strong>rxvtc</strong>, too. Please note that options are interpreted in the
context of the daemon process. However, as current working directory,
process environment and any file descriptor (e.g. for <code>-pty-fd</code>) are
preserved, this rarely makes a difference.</p>
<p>
</p>
<hr />
<h1><a name="exit_status">EXIT STATUS</a></h1>
<p>If everything went well, rxvtc returns with an exit status of <code>0</code>.
If contacting the daemon fails, it exits with the exit status <code>2</code>. In all other error
cases it returns with status <code>1</code>.</p>
<p>This can be used to implement auto-starting behaviour, by checking for an
exit status of <code>2</code>, running <code>rxvtd -f -q</code> and retrying the call
to rxvtc, like this:</p>
<pre>
   #!/bin/sh
   rxvtc &quot;$@&quot;
   if [ $? -eq 2 ]; then
      rxvtd -q -o -f
      rxvtc &quot;$@&quot;
   fi</pre>
<p>
</p>
<hr />
<h1><a name="environment">ENVIRONMENT</a></h1>
<p>All environment variables of the current process will be made available
to the new instance, and will be interpreted as if <strong>rxvt</strong> were
started directly.</p>
<dl>
<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong>

<dd>
<p>Both rxvtc and rxvtd use the environment variable
<em>RXVT_SOCKET</em> to create a listening socket and to contact the
rxvtd, respectively. If the variable is missing,
<em>$HOME/.rxvt-unicode-<em>&lt;nodename</em> </em>&gt; &gt;&gt;&gt; is used.  The variable must
specify the absolute path of the socket to create.</p>
</dd>
</li>
</dl>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p>rxvt(7), <code>rxvtd(1)</code></p>

</body>

</html>
Revision:	1.6
Committed:	Mon Aug 7 16:17:30 2006 UTC (17 years, 11 months ago) by root
Content type:	text/html
Branch:	MAIN
CVS Tags:	rel-7_9, rel-8_0, rel-8_1, rel-8_2
Changes since 1.5:	+1 -1 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.4	<?xml version="1.0" ?>
2	root	1.1	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3			<html xmlns="http://www.w3.org/1999/xhtml">
4			<head>
5	root	1.5	<title>rxvtc - control the rxvtd daemon</title>
6	root	1.4	<meta http-equiv="content-type" content="text/html; charset=utf-8" />
7	root	1.1	<link rev="made" href="mailto:perl-binary@plan9.de" />
8			</head>
9
10			<body style="background-color: white">
11
12			<p><a name="__index__"></a></p>
13			<!-- INDEX BEGIN -->
14
15			<ul>
16
17			<li><a href="#name">NAME</a></li>
18			<li><a href="#synopsis">SYNOPSIS</a></li>
19			<li><a href="#description">DESCRIPTION</a></li>
20			<li><a href="#options">OPTIONS</a></li>
21	root	1.3	<li><a href="#exit_status">EXIT STATUS</a></li>
22	root	1.1	<li><a href="#environment">ENVIRONMENT</a></li>
23			<li><a href="#see_also">SEE ALSO</a></li>
24			</ul>
25			<!-- INDEX END -->
26
27			<hr />
28			<p>
29			</p>
30			<h1><a name="name">NAME</a></h1>
31	root	1.5	<p>rxvtc - control the rxvtd daemon</p>
32	root	1.1	<p>
33			</p>
34			<hr />
35			<h1><a name="synopsis">SYNOPSIS</a></h1>
36	root	1.5	<p><strong>rxvtc</strong> [same options as for rxvt]</p>
37	root	1.1	<p>
38			</p>
39			<hr />
40			<h1><a name="description">DESCRIPTION</a></h1>
41	root	1.5	<p>This manpage describes the <strong>rxvtc</strong> client program. It connects
42			to the <strong>rxvtd</strong> daemon and requests a new terminal window. It
43			takes the same arguments as the <strong>rxvt</strong> program. The environment
44	root	1.1	will also be respected. Currently, it always returns immediately after
45			contacting the daemon.</p>
46			<p>
47			</p>
48			<hr />
49			<h1><a name="options">OPTIONS</a></h1>
50	root	1.5	<p>All options that are valid for <strong>rxvt</strong> are valid for
51			<strong>rxvtc</strong>, too. Please note that options are interpreted in the
52			context of the daemon process. However, as current working directory,
53	root	1.6	process environment and any file descriptor (e.g. for <code>-pty-fd</code>) are
54	root	1.5	preserved, this rarely makes a difference.</p>
55	root	1.1	<p>
56			</p>
57			<hr />
58	root	1.3	<h1><a name="exit_status">EXIT STATUS</a></h1>
59	root	1.5	<p>If everything went well, rxvtc returns with an exit status of <code>0</code>.
60	root	1.3	If contacting the daemon fails, it exits with the exit status <code>2</code>. In all other error
61			cases it returns with status <code>1</code>.</p>
62			<p>This can be used to implement auto-starting behaviour, by checking for an
63	root	1.5	exit status of <code>2</code>, running <code>rxvtd -f -q</code> and retrying the call
64			to rxvtc, like this:</p>
65			<pre>
66			#!/bin/sh
67			rxvtc "$@"
68			if [ $? -eq 2 ]; then
69			rxvtd -q -o -f
70			rxvtc "$@"
71			fi</pre>
72	root	1.3	<p>
73			</p>
74			<hr />
75	root	1.1	<h1><a name="environment">ENVIRONMENT</a></h1>
76			<p>All environment variables of the current process will be made available
77	root	1.5	to the new instance, and will be interpreted as if <strong>rxvt</strong> were
78	root	1.1	started directly.</p>
79			<dl>
80	root	1.4	<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong>
81
82	root	1.1	<dd>
83	root	1.5	<p>Both rxvtc and rxvtd use the environment variable
84	root	1.2	<em>RXVT_SOCKET</em> to create a listening socket and to contact the
85	root	1.5	rxvtd, respectively. If the variable is missing,
86	root	1.2	<em>$HOME/.rxvt-unicode-<em><nodename</em> </em>> >>> is used. The variable must
87	root	1.4	specify the absolute path of the socket to create.</p>
88	root	1.1	</dd>
89	root	1.4	</li>
90			</dl>
91	root	1.1	<p>
92			</p>
93			<hr />
94			<h1><a name="see_also">SEE ALSO</a></h1>
95	root	1.5	<p>rxvt(7), <code>rxvtd(1)</code></p>
96	root	1.1
97			</body>
98
99			</html>