File: rxvtc.1.pod

package info (click to toggle)
rxvt-unicode 9.22-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,476 kB
  • ctags: 5,351
  • sloc: ansic: 44,050; cpp: 18,621; sh: 3,235; perl: 2,972; makefile: 584
file content (66 lines) | stat: -rw-r--r-- 2,019 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
=head1 NAME

@@RXVT_NAME@@c - control the @@RXVT_NAME@@d daemon

=head1 SYNOPSIS

B<@@RXVT_NAME@@c> [same options as for @@RXVT_NAME@@]

=head1 DESCRIPTION

This manpage describes the B<@@RXVT_NAME@@c> client program. It connects
to the B<@@RXVT_NAME@@d> daemon and requests a new terminal window. It
takes the same arguments as the B<@@RXVT_NAME@@> program. The environment
will also be respected. Currently, it always returns immediately after
contacting the daemon.

=head1 OPTIONS

If the first option is B<-k>, B<@@RXVT_NAME@@c> tries to kill the
daemon process and returns.

All options that are valid for B<@@RXVT_NAME@@> are valid for
B<@@RXVT_NAME@@c>, 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 C<-pty-fd>) are
preserved, this rarely makes a difference.

=head1 EXIT STATUS

If everything went well, @@RXVT_NAME@@c returns with an exit status of C<0>.
If contacting the daemon fails, it exits with the exit status C<2>. In all other error
cases it returns with status C<1>.

This can be used to implement auto-starting behaviour, by checking for an
exit status of C<2>, running C<@@RXVT_NAME@@d -f -q> and retrying the call
to @@RXVT_NAME@@c, like this:

   #!/bin/sh
   @@RXVT_NAME@@c "$@"
   if [ $? \-eq 2 ]; then
      @@RXVT_NAME@@d \-q \-o \-f
      @@RXVT_NAME@@c "$@"
   fi

=head1 ENVIRONMENT

All environment variables of the current process will be made available
to the new instance, and will be interpreted as if B<@@RXVT_NAME@@> were
started directly.

=over 4

=item B<RXVT_SOCKET>

Both @@RXVT_NAME@@c and @@RXVT_NAME@@d use the environment variable
F<RXVT_SOCKET> to create a listening socket and to contact the
@@RXVT_NAME@@d, respectively. If the variable is missing,
F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>> is used.  The variable must
specify the absolute path of the socket to create.

=back

=head1 SEE ALSO

@@RXVT_NAME@@(7), @@RXVT_NAME@@d(1)