doc/commands/Restart.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3   "../docbook-xml/docbookx.dtd"
   4 [
   5 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   6 %myents;
   7 ]>
   8
   9 <!-- $Id: Restart.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Restart'>
  12 <title>Restart</title>
  13
  14 <cmdsynopsis>
  15         <command>Restart</command
  16         ><arg choice='opt'
  17                 ><replaceable>window_manager</replaceable
  18                 ><arg choice='opt'
  19                         ><replaceable>params</replaceable
  20                 ></arg>
  21         </arg>
  22 </cmdsynopsis>
  23
  24 <para>Causes fvwm to restart itself if
  25 <replaceable>window_manager</replaceable>
  26 is left blank, or to switch to an alternate window manager (or
  27 other fvwm version) if
  28 <replaceable>window_manager</replaceable>
  29 is specified.  If the window manager is not in your default search
  30 path, then you should use the full path name for
  31 <replaceable>window_manager</replaceable>.</para>
  32
  33 <para>This command should not have a trailing ampersand.  The command
  34 can have optional parameters with simple shell-like syntax.  You
  35 can use
  36 <filename>~</filename>
  37 (is expanded to the user's home directory) and environmental
  38 variables
  39 <envar>$VAR</envar> or <envar>${VAR}</envar>.
  40 Here are several examples:</para>
  41
  42 <programlisting>
  43 <fvwmref cmd="Key"/> F1 R N Restart
  44 <fvwmref cmd="Key"/> F1 R N Restart fvwm -s
  45 <fvwmref cmd="Key"/> F1 R N Restart ~/bin/fvwm -f $HOME/.fvwm/main
  46 <fvwmref cmd="Key"/> F1 R N Restart fvwm1 -s -f .fvwmrc
  47 <fvwmref cmd="Key"/> F1 R N Restart xterm -n '"X console"' \
  48   -T \"X\&nbsp;console\" -e fvwm1 -s
  49 </programlisting>
  50
  51 <para>If you need a native restart, we suggest only to use
  52 <emphasis remap='B'>Restart</emphasis>
  53 command without parameters unless there is a reason not to.  If you
  54 still use an old command 'Restart fvwm2' that was correct in 2.2.x,
  55 all current command line arguments are lost.  On a restart without
  56 parameters or with --pass-args, they are preserved.  Here are some
  57 cases when 'Restart fvwm2' or 'Restart fvwm' cause troubles:</para>
  58
  59 <programlisting>
  60 * running fvwm under a session manager
  61 * running fvwm with multi headed displays
  62 * having command line arguments, like
  63   -f themes-rc or -cmd
  64 * if the first fvwm2 in the $PATH is a
  65   different one
  66 </programlisting>
  67
  68 <para>This is why we are issuing a warning on an old usage. If you
  69 really want to restart to fvwm with no additional arguments, you
  70 may get rid of this warning by using "Restart fvwm -s" or
  71 "Restart /full/path/fvwm".</para>
  72
  73 <para>Note, currently with multi headed displays, restart of fvwms on
  74 different screens works independently.</para>
  75
  76
  77 <cmdsynopsis>
  78         <command>Restart</command
  79         ><arg choice='plain'
  80                 ><option>--pass-args</option
  81         ></arg
  82         ><arg choice='plain'
  83                 ><replaceable>window_manager</replaceable
  84         ></arg>
  85 </cmdsynopsis>
  86
  87
  88 <para>The same as
  89 <emphasis remap='B'>Restart</emphasis>
  90 without parameters but the name for the current window manager is
  91 replaced with the specified
  92 <replaceable>window_manager</replaceable>
  93 and original arguments are preserved.</para>
  94
  95 <para>This command is useful if you use initial arguments like</para>
  96
  97 <programlisting>
  98 -cmd FvwmCpp
  99 </programlisting>
 100
 101 <para>and want to switch to another fvwm version without losing the
 102 initial arguments.</para>
 103
 104
 105 <cmdsynopsis>
 106         <command>Restart</command
 107         ><arg choice='plain'
 108                 ><option>--dont-preserve-state</option
 109         ></arg
 110         ><arg choice='opt'
 111                 ><replaceable>other-params</replaceable
 112         ></arg>
 113 </cmdsynopsis>
 114
 115
 116 <para>The same as</para>
 117
 118 <programlisting>
 119 <emphasis remap='B'>Restart</emphasis> <optional><replaceable>other-params</replaceable></optional>
 120 </programlisting>
 121
 122 <para>but it does not save any window states over the restart.</para>
 123
 124 <para>Without this option,
 125 <emphasis remap='B'>Restart</emphasis>
 126 preserves most per-window state by writing it to a file named
 127 <filename>.fs-restart-<envar>$HOSTDISPLAY</envar></filename>
 128 in the user's home directory.</para>
 129
 130 </section>