ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtc.1.pod
Revision: 1.8
Committed: Sat Jul 24 09:48:43 2021 UTC (2 years, 11 months ago) by root
Branch: MAIN
CVS Tags: rxvt-unicode-rel-9_29, rxvt-unicode-rel-9_30, HEAD
Changes since 1.7: +1 -1 lines
Log Message:
remove =over identation

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