ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtc.1.pod
Revision: 1.3
Committed: Wed Feb 1 18:07:18 2006 UTC (18 years, 5 months ago) by root
Branch: MAIN
CVS Tags: rel-7_7, rel-7_6, rel-7_8
Changes since 1.2: +10 -0 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 =head1 NAME
2
3 @@RXVT_NAME@@c - control the @@RXVT_NAME@@d daemon
4
5 =head1 SYNOPSIS
6
7 B<@@RXVT_NAME@@c> [same options as for @@RXVT_NAME@@]
8
9 =head1 DESCRIPTION
10
11 This manpage describes the B<@@RXVT_NAME@@c> client program. It connects
12 to the B<@@RXVT_NAME@@d> daemon and requests a new terminal window. It
13 takes the same arguments as the B<@@RXVT_NAME@@> program. The environment
14 will also be respected. Currently, it always returns immediately after
15 contacting the daemon.
16
17 =head1 OPTIONS
18
19 All options that are valid for B<@@RXVT_NAME@@> are valid for
20 B<@@RXVT_NAME@@c>, too. Please note that all options are currently
21 interpreted in the context of the daemon process, which makes a difference
22 for options that specify a file descriptor (such as B<-pty-fd>).
23
24 =head1 EXIT STATUS
25
26 If everything went well, @@RXVT_NAME@@c returns with an exit status of C<0>.
27 If contacting the daemon fails, it exits with the exit status C<2>. In all other error
28 cases it returns with status C<1>.
29
30 This can be used to implement auto-starting behaviour, by checking for an
31 exit status of C<2>, running C<@@RXVT_NAME@@d -f -q> and retrying the call
32 to @@RXVT_NAME@@c.
33
34 =head1 ENVIRONMENT
35
36 All environment variables of the current process will be made available
37 to the new instance, and will be interpreted as if B<@@RXVT_NAME@@> were
38 started directly.
39
40 =over 4
41
42 =item B<RXVT_SOCKET>
43
44 Both @@RXVT_NAME@@c and @@RXVT_NAME@@d use the environment variable
45 F<RXVT_SOCKET> to create a listening socket and to contact the
46 @@RXVT_NAME@@d, respectively. If the variable is missing,
47 F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>> is used. The variable must
48 specify the absolute path of the socket to create.
49
50 =back
51
52 =head1 SEE ALSO
53
54 @@RXVT_NAME@@(7), @@RXVT_NAME@@d(1)
55