ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtc.1.pod
Revision: 1.5
Committed: Mon Aug 7 16:04:29 2006 UTC (17 years, 11 months ago) by root
Branch: MAIN
CVS Tags: rel-7_9, rel-9_11, rel-9_10, rel-8_1, rel-9_12, rel-8_5a, rel-8_9, rel-8_8, rel-9_0, rel-8_0, rel-8_4, rel-8_2, rel-8_3, rel-8_6, rel-8_7, rel-9_09, rel-9_02, rel-9_01, rel-9_06, rel-9_07, rel-9_05
Changes since 1.4: +1 -1 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.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 root 1.4 B<@@RXVT_NAME@@c>, too. Please note that options are interpreted in the
21     context of the daemon process. However, as current working directory,
22 root 1.5 process environment and any file descriptor (e.g. for C<-pty-fd>) are
23 root 1.4 preserved, this rarely makes a difference.
24 root 1.1
25 root 1.3 =head1 EXIT STATUS
26    
27     If everything went well, @@RXVT_NAME@@c returns with an exit status of C<0>.
28     If contacting the daemon fails, it exits with the exit status C<2>. In all other error
29     cases it returns with status C<1>.
30    
31     This can be used to implement auto-starting behaviour, by checking for an
32     exit status of C<2>, running C<@@RXVT_NAME@@d -f -q> and retrying the call
33 root 1.4 to @@RXVT_NAME@@c, like this:
34    
35     #!/bin/sh
36     @@RXVT_NAME@@c "$@"
37     if [ $? -eq 2 ]; then
38     @@RXVT_NAME@@d -q -o -f
39     @@RXVT_NAME@@c "$@"
40     fi
41 root 1.3
42 root 1.1 =head1 ENVIRONMENT
43    
44     All environment variables of the current process will be made available
45     to the new instance, and will be interpreted as if B<@@RXVT_NAME@@> were
46     started directly.
47    
48     =over 4
49    
50     =item B<RXVT_SOCKET>
51    
52     Both @@RXVT_NAME@@c and @@RXVT_NAME@@d use the environment variable
53 root 1.2 F<RXVT_SOCKET> to create a listening socket and to contact the
54     @@RXVT_NAME@@d, respectively. If the variable is missing,
55     F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>> is used. The variable must
56     specify the absolute path of the socket to create.
57 root 1.1
58     =back
59    
60     =head1 SEE ALSO
61    
62     @@RXVT_NAME@@(7), @@RXVT_NAME@@d(1)
63