doc/rxvtc.1.pod

   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 options are interpreted in the
  21 context of the daemon process. However, as current working directory,
  22 process environment and any file descriptor (e.g. for C<-pty-fd>) are
  23 preserved, this rarely makes a difference.
  24
  25 =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 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
  42 =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 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
  58 =back
  59
  60 =head1 SEE ALSO
  61
  62 @@RXVT_NAME@@(7), @@RXVT_NAME@@d(1)
  63