lib/examples/linuxdoc_manpage.lyx

   1 #LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
   2 \lyxformat 245
   3 \begin_document
   4 \begin_header
   5 \textclass manpage
   6 \options title="LyX" sectnum="1"
   7 \language english
   8 \inputencoding default
   9 \fontscheme default
  10 \graphics default
  11 \paperfontsize 10
  12 \spacing single
  13 \papersize default
  14 \use_geometry false
  15 \use_amsmath 0
  16 \cite_engine basic
  17 \use_bibtopic false
  18 \paperorientation portrait
  19 \secnumdepth -2
  20 \tocdepth -1
  21 \paragraph_separation indent
  22 \defskip medskip
  23 \quotes_language english
  24 \papercolumns 1
  25 \papersides 1
  26 \paperpagestyle default
  27 \tracking_changes false
  28 \output_changes true
  29 \end_header
  30
  31 \begin_body
  32
  33 \begin_layout Section
  34
  35 Name
  36 \end_layout
  37
  38 \begin_layout Standard
  39
  40 lyx - A Document Processor
  41 \end_layout
  42
  43 \begin_layout Section
  44
  45 Synopsis
  46 \end_layout
  47
  48 \begin_layout Standard
  49
  50 lyx [ command-line switches] [name.lyx ...
  51  ]
  52 \end_layout
  53
  54 \begin_layout Section
  55
  56 Description
  57 \end_layout
  58
  59 \begin_layout Standard
  60
  61
  62 \emph on
  63 LyX
  64 \emph default
  65  is too complex to be described completely in the "man" page format.
  66  If your system is properly configured, you can access the full documentation
  67  within
  68 \emph on
  69 LyX
  70 \emph default
  71  under the Help menu.
  72
  73 \end_layout
  74
  75 \begin_layout Standard
  76
  77
  78 \emph on
  79 LyX
  80 \emph default
  81  is a modern approach of writing documents with a computer which breaks
  82  with the tradition of the obsolete typewriter concept.
  83  It is designed for people who want a professional output with a minimum
  84  of time effort, without becoming specialists in typesetting.
  85  Compared to common word processors,
  86 \emph on
  87 LyX
  88 \emph default
  89  will increase the productivity a lot, since most of the typesetting will
  90  be done by the computer, not the author.
  91  With
  92 \emph on
  93 LyX
  94 \emph default
  95  the author can concentrate on the contents of his writing, since the computer
  96  will take care of the look.
  97  Read more about this concept in the online documentation under the Help
  98  menu.
  99
 100 \end_layout
 101
 102 \begin_layout Standard
 103
 104 Currently,
 105 \emph on
 106 LyX
 107 \emph default
 108  uses the XForms library as a toolkit.
 109
 110 \emph on
 111 LyX
 112 \emph default
 113  should run everywhere, where XForms runs.
 114  This is on all major Unix platforms as well as some PC platforms, including
 115  Sun, SGI, HP, Compaq Tru64, IBM RS6000, Convex, Cray, i386/Linux, Alpha/Linux,
 116  i386/FreeBSD, i386/NetBSD, DecSystem(mips)/Ultrix, OS/2 with XFree or PMX
 117  and others.
 118
 119 \end_layout
 120
 121 \begin_layout Section
 122
 123 Options
 124 \end_layout
 125
 126 \begin_layout Standard
 127
 128
 129 \emph on
 130 LyX
 131 \emph default
 132  supports the following command-line switches, which can also be specified
 133  as X resources (e.
 134  g.
 135  in .Xdefaults) with class name
 136 \emph on
 137 LyX
 138 \emph default
 139 :
 140 \end_layout
 141
 142 \begin_layout Description
 143
 144 -help summarizes LyX usage
 145 \end_layout
 146
 147 \begin_layout Description
 148
 149 -sysdir directory sets system directory.
 150  Normally not needed.
 151 \end_layout
 152
 153 \begin_layout Description
 154
 155 -userdir directory sets user directory.
 156  Needed if you want to use LyX with different lyxrc settings.
 157 \end_layout
 158
 159 \begin_layout Description
 160
 161 -geometry WxH+X+Y specifies the preferred size and position of the main
 162  LyX window; see X(1).
 163 \end_layout
 164
 165 \begin_layout Description
 166
 167 -dbg feature[,feature...] where feature is a name or number.
 168  Use "lyx -dbg" to see the list of available debug features.
 169 \end_layout
 170
 171 \begin_layout Description
 172
 173 -x [--execute] command where command is a lyx command.
 174 \end_layout
 175
 176 \begin_layout Description
 177
 178 -e [--export] fmt where fmt is the export format of choice.
 179 \end_layout
 180
 181 \begin_layout Description
 182
 183 -i [--import] fmt file.xxx where fmt is the import format of choice and file.xxx
 184  is the file to be imported.
 185
 186 \end_layout
 187
 188 \begin_layout Standard
 189
 190 Furthermore, LyX understands the following generic command line options
 191  from the Forms Library:
 192 \end_layout
 193
 194 \begin_layout Description
 195
 196 -display host:display specifies the server to connect to.
 197 \end_layout
 198
 199 \begin_layout Description
 200
 201 -bw borderwidth specifies the border width to use to built-in objects.
 202 \end_layout
 203
 204 \begin_layout Description
 205
 206 -visual visualName requests a visual by name such as TrueColor etc.
 207  By default the Forms Library always selects the visual that has the most
 208  depth.
 209 \end_layout
 210
 211 \begin_layout Description
 212
 213 -depth depth requests a specific depth.
 214  Try "-depth best" or "-depth 8" if you get a bad match.
 215 \end_layout
 216
 217 \begin_layout Description
 218
 219 -debug level generates some info about the state of the XForms.
 220  where level is an integer between 1-5 and controls the amount of information
 221  to output.
 222  Depending on the options used when the Forms Library was built, a level
 223  more than 3 might not be available.
 224 \end_layout
 225
 226 \begin_layout Description
 227
 228 -sync runs the application in synchronous mode with debug level set to 4.
 229 \end_layout
 230
 231 \begin_layout Description
 232
 233 -private requests a private colormap for the application.
 234 \end_layout
 235
 236 \begin_layout Description
 237
 238 -shared requests a shared colormap even if the application needs more colors
 239  than available.
 240  For those colors that can't be allocated in the shared colormap, substitutions
 241  are made so the closest matching color is used.
 242 \end_layout
 243
 244 \begin_layout Description
 245
 246 -stdcmap requests a standard colormap.
 247 \end_layout
 248
 249 \begin_layout Description
 250
 251 -name newname specifies the application name under which resources are to
 252  be obtained, rather than the default executable file name.
 253
 254 \end_layout
 255
 256 \end_body
 257 \end_document