lyx.man

   1 .\" Man page for LyX.
   2 .\" Use the following command to view man page:
   3 .\"
   4 .\"  tbl lyx.1 | nroff -man | less
   5 .\"
   6 .TH LYX 1 "November 1999" "Version 1.1" "LyX 1.1"
   7 .SH NAME
   8 lyx \- A Document Processor
   9 .\"
  10 .\" setup
  11 .de Cr
  12 .ie n (c)
  13 .el \(co
  14 ..
  15 .SH SYNOPSIS
  16 \fBlyx\fR [ \fIcommand-line switches\fR] [\fIname.lyx ...\fR ]
  17 .br
  18 .SH DESCRIPTION
  19 \fBLyX\fR is too complex to be described completely in the "man" page
  20 format. If your system is properly configured, you can access the full
  21 documentation within \fBLyX\fR under the Help menu.
  22
  23 \fBLyX\fR is a modern approach of writing documents with a computer
  24 which breaks with the tradition of the obsolete typewriter concept. It
  25 is designed for people who want a professional output with a minimum
  26 of time effort, without becoming specialists in typesetting. Compared
  27 to common word processors, \fBLyX\fR will increase the productivity a
  28 lot, since most of the typesetting will be done by the computer, not
  29 the author. With \fBLyX\fR the author can concentrate on the contents
  30 of his writing, since the computer will take care of the look. Read more
  31 about this concept in the online documentation under the Help menu.
  32
  33 Currently, \fBLyX\fR uses the XForms library as a toolkit. \fBLyX\fR
  34 should run everywhere, where XForms runs. This is on all major Unix
  35 platforms as well as some PC platforms, including Sun, SGI, HP, DEC
  36 Alpha/OSF, IBM RS6000, Convex, Cray, i386/Linux, Alpha/Linux,
  37 i386/FreeBSD, i386/NetBSD, DecSystem(mips)/Ultrix, OS/2 with XFree or
  38 PMX and others.
  39
  40 .SH OPTIONS
  41 \fBLyX\fR supports the following command-line switches, which can also
  42 be specified as X resources (e. g. in .Xdefaults) with class
  43 name \fBLyX\fR:
  44 .TP 6
  45 .BI \-help
  46 summarizes LyX usage
  47 .TP
  48 .BI \-sysdir " directory"
  49 sets system directory. Normally not needed.
  50 .TP
  51 .BI \-userdir " directory"
  52 sets user directory. Needed if you want to use LyX with different lyxrc
  53 settings.
  54 .TP
  55 .BI \-width " x"
  56 the width of the main window in \fBLyX\fR.
  57 .TP
  58 .BI \-height " y"
  59 the height of the main window in \fBLyX\fR.
  60 .TP
  61 .BI \-xpos " x"
  62 the x position of the main window in \fBLyX\fR.
  63 .TP
  64 .BI \-ypos " y"
  65 the y position of the main window in \fBLyX\fR.
  66 Notice, you have to specify both
  67 .BI \-xpos
  68 and
  69 .BI \-ypos
  70 to obtain the
  71 desired effect. Negative positions are ignored. If no valid position
  72 is given, the main window is centered.
  73 .TP
  74 .BI \-dbg " feature[,feature...]"
  75 where feature is a name or number.
  76 Use "\fBlyx -dbg\fR" to see the list of available debug features.
  77 .TP
  78 .BI \-Reverse
  79 swaps foreground and background colors.
  80 .TP
  81 .BI \-Mono
  82 runs \fBLyX\fR in black and white mode.
  83 .TP
  84 .BI \-FastSelection
  85 uses a fast black and white drawing routine for selections. If you use
  86 this, the switches BackgroundColor and SelectionColor are ignored.
  87 .PP
  88 The following options can be used to define the colors to use for
  89 different things:
  90 .TP
  91 .BI \-MathColor " color"
  92 .TP
  93 .BI \-MathFrameColor " color"
  94 .TP
  95 .BI \-FootColor " color"
  96 .TP
  97 .BI \-LabelColor " color"
  98 .TP
  99 .BI \-FillColor " color"
 100 .TP
 101 .BI \-NewLineColor " color"
 102 .TP
 103 .BI \-OnOffLineColor " color"
 104 .TP
 105 .BI \-LatexColor " color"
 106 .TP
 107 .BI \-NoteColor " color"
 108 .TP
 109 .BI \-LightedColor " color"
 110 .TP
 111 .BI \-BackgroundColor " color"
 112 .TP
 113 .BI \-SelectionColor " color"
 114 .PP
 115 Furthermore, \fBLyX\fR understands the following generic command line options
 116 from the \fBForms Library\fR:
 117 .TP 6
 118 .BI \-display " host:display"
 119 specifies the server to connect to.
 120 .TP
 121 .BI \-bw " borderwidth"
 122 specifies the border width to use to built-in objects.
 123 .TP
 124 .BI \-visual " visualName"
 125 requests a visual by name such as TrueColor etc. By default the
 126 .B Forms Library
 127 always selects the visual that has the most depth.
 128 .TP
 129 .BI \-depth " depth"
 130 requests a specific depth. Try "\fB-depth\fR best" or "\fB-depth\fR
 131 8" if you get a bad match.
 132 .TP
 133 .BI \-debug " level"
 134 generates some info about the state of the
 135 .B XForms.
 136 where
 137 .I level
 138 is an integer between 1-5 and controls the amount of
 139 information to output. Depending on the options used
 140 when the
 141 .B Forms Library
 142 was built, a level more than 3 might not be available.
 143 .TP
 144 .B \-sync
 145 runs the application in synchronous mode with debug level set to 4.
 146 .TP
 147 .B \-private
 148 requests a private colormap for the application.
 149 .TP
 150 .B \-shared
 151 requests a shared colormap even if the application needs more
 152 colors than available. For those colors that can't be allocated
 153 in the shared colormap, substitutions are made so the closest
 154 matching color is used.
 155 .TP
 156 .B \-stdcmap
 157 requests a standard colormap.
 158 .TP
 159 .B \-name " newname"
 160 specifies the application name under which resources are to be
 161 obtained, rather than the default executable file name.
 162 .SH ENVIRONMENT
 163 .TP
 164 .B LYX_DIR_11x
 165 can be used to specify which system directory to use.
 166 .PP
 167 The system directory is determined by searching for the file
 168 "chkconfig.ltx". Directories are searched in this order:
 169 .br
 170 1) -sysdir command line parameter
 171 .br
 172 2) LYX_DIR_11x environment variable
 173 .br
 174 3) Maybe <path of binary>/TOP_SRCDIR/lib
 175 .br
 176 4) <path of binary>/../share/<name of binary>/
 177 .br
 178 5) hardcoded lyx_dir (usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree)
 179
 180 .TP
 181 .B LYX_USERDIR_11x
 182 can be used to specify which user directory to use.
 183 .PP
 184 The user directory is, in order of precedence:
 185 .br
 186 1) -usedir command line parameter
 187 .br
 188 2) LYX_USERDIR_11x environment variable
 189 .br
 190 3) $HOME/.<name of binary> if no explicit setting is made
 191
 192 .TP
 193 .B LYX_LOCALEDIR
 194 can be used to tell LyX where to look for the translations of its GUI
 195 strings in other languages.
 196
 197 .SH FILES
 198 .nf
 199 .ta \w'\fILIBDIR\fR/lyxrc.in  'u
 200 ~/.lyx/lyxrc      Personal configuration file
 201 \fILIBDIR\fR/lyxrc      System wide configuration file
 202 \fILIBDIR\fR/lyxrc.example System wide configuration file template
 203 \fILIBDIR\fR/configure  Updates \fBLyX\fR if config has changed
 204 \fILIBDIR\fR/bind/      Keybindings
 205 \fILIBDIR\fR/clipart/   Clipart pictures
 206 \fILIBDIR\fR/doc/       Documentation in \fBLyX\fR format.
 207 \fILIBDIR\fR/examples/  Example documents
 208 \fILIBDIR\fR/images/    Images used as icons or in popups
 209 \fILIBDIR\fR/kbd/       Keyboard mappings
 210 \fILIBDIR\fR/layouts/   Layout descriptions
 211 \fILIBDIR\fR/templates/ Templates for documents
 212 \fILIBDIR\fR/tex/       Extra TeX files
 213 .Sp
 214 .fi
 215
 216 .I LIBDIR
 217 is the system directory. This is usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree.
 218
 219 .SH SEE ALSO
 220 reLyX(1), latex(1), xforms(5).
 221
 222 Full documentation in either native \fBLyX\fR or postscript format.
 223 .SH BUGS/LIMITATIONS
 224 There are probably still some bugs in \fBLyX\fR. Please report them to
 225 lyx-devel@lists.lyx.org with detailed info, including which version of \fBLyX\fR
 226 you use.  Consult the "Known Bugs" item under the Help menu first if possible.
 227
 228 \fBLaTeX\fR import is still not perfect and may produce buggy *.lyx files. Consult the \fBreLyX\fR documentation.
 229
 230 XFree on OS/2 currently does not support PC codepages. If you use \fBemTeX\fR to preview/print with cp850, etc., this might lead to strange \fBemTeX\fR error messages.
 231 .B Remedy:
 232   1) In filenames use only A-Z, a-z, 1-9.
 233   2) Install a recent \fBLaTeX\fR package inputenc.sty. Select Layout->Document->encoding:latin1, so that \fBreLyX\fR adds the \fBLaTeX\fR command '\\usepackage[latin1]{inputenc}'.
 234
 235 \fBLyX\fR server has some limitations under OS/2: See Help->Customization for details.
 236
 237 Preview of inline images in rare cases does not show the image. If you want to preview the image, just click on it and choose fullscreen preview.
 238
 239 If you have performance problems, please go through the \fBlyxrc\fR
 240 configuration file.  It contains settings that can be used to improve
 241 performance on slow systems.
 242
 243
 244
 245 .SH AUTHOR
 246 Copyright
 247 .Cr
 248 1995, 1996, 1997, 1998, 1999 by Matthias Ettrich (ettrich@informatik.uni-tuebingen.de)
 249 and the rest of the \fBLyX Team\fR (See Credits under the Help menu
 250 item).