ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtc.1.pod
Revision: 1.7
Committed: Mon Oct 6 11:14:49 2014 UTC (9 years, 8 months ago) by sf-exg
Branch: MAIN
CVS Tags: rxvt-unicode-rel-9_26, rxvt-unicode-rel-9_25, rxvt-unicode-rel-9_22, rxvt-unicode-rel-9_21
Changes since 1.6: +3 -0 lines
Log Message:
Add -k option to urxvtc for killing the daemon process.

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 If the first option is B<-k>, B<@@RXVT_NAME@@c> tries to kill the
20 daemon process and returns.
21
22 All options that are valid for B<@@RXVT_NAME@@> are valid for
23 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 process environment and any file descriptor (e.g. for C<-pty-fd>) are
26 preserved, this rarely makes a difference.
27
28 =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 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
45 =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 =over 4
52
53 =item B<RXVT_SOCKET>
54
55 Both @@RXVT_NAME@@c and @@RXVT_NAME@@d use the environment variable
56 F<RXVT_SOCKET> to create a listening socket and to contact the
57 @@RXVT_NAME@@d, respectively. If the variable is missing,
58 F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>> is used. The variable must
59 specify the absolute path of the socket to create.
60
61 =back
62
63 =head1 SEE ALSO
64
65 @@RXVT_NAME@@(7), @@RXVT_NAME@@d(1)
66