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 "April 2002" "Version 1.2" "LyX 1.2"
   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 document preparation system. It excels at letting you create
  24 complex technical and scientific articles with mathematics,
  25 cross-references, bibliographies, indices, etc. It is very good at
  26 documents of any length in which the usual processing abilities are
  27 required: automatic sectioning and pagination, spellchecking, and so
  28 forth. It can also be used to write a letter to your mom, though
  29 granted, there are probably simpler programs available for that. It is
  30 definitely not the best tool for creating banners, flyers, or
  31 advertisements (we'll explain why later), though with some effort all
  32 these can be done, too. Some examples of what it is used for: memos,
  33 letters, dissertations and theses, lecture notes, seminar notebooks,
  34 conference proceedings, software documentation, books (on PostgreSQL,
  35 remote sensing, cryptology, fictional novels, poetry, and even a
  36 children's book or two), articles in refereed scientific journals,
  37 scripts for plays and movies, business proposals... you get the idea.
  38
  39 Currently, \fBLyX\fR uses the XForms library as a toolkit. \fBLyX\fR
  40 should run everywhere, where XForms runs. This is on all major Unix
  41 platforms as well as Windows, Mac OS X (which actually is a unix
  42 platform) and OS/2.
  43 .SH OPTIONS
  44 \fBLyX\fR supports the following command-line switches, which can also
  45 be specified as X resources (e. g. in .Xdefaults) with class
  46 name \fBLyX\fR:
  47 .TP 6
  48 .BI \-help
  49 summarizes LyX usage
  50 .TP
  51 .BI \-version
  52 provides version information on the build of LyX.
  53 .TP
  54 .BI \-sysdir " directory"
  55 sets system directory. Normally not needed.
  56 .TP
  57 .BI \-userdir " directory"
  58 sets user directory. Needed if you want to use LyX with different lyxrc
  59 settings.
  60 .TP
  61 .BI \-geometry " WxH+X+Y"
  62 specifies the preferred size and position of the main \fBLyX\fR window; see \fIX(1)\fR.
  63 .TP
  64 .BI \-dbg " feature[,feature...]"
  65 where feature is a name or number.
  66 Use "\fBlyx -dbg\fR" to see the list of available debug features.
  67 .TP
  68 \fB -x [--execute]\fP \fIcommand
  69 where command is a lyx command.
  70 .TP
  71 \fB -e [--export]\fP \fIfmt
  72 where fmt is the export format of choice.
  73 .TP
  74 \fB -i [--import]\fP \fIfmt file.xxx
  75 where fmt is the import format of choice and file.xxx is the file to be imported.
  76
  77 .PP
  78 Furthermore, \fBLyX\fR understands the following generic command line options
  79 from the \fBForms Library\fR:
  80 .TP 6
  81 .BI \-display " host:display"
  82 specifies the server to connect to.
  83 .TP
  84 .BI \-bw " borderwidth"
  85 specifies the border width to use to built-in objects.
  86 .TP
  87 .BI \-visual " visualName"
  88 requests a visual by name such as TrueColor etc. By default the
  89 .B Forms Library
  90 always selects the visual that has the most depth.
  91 .TP
  92 .BI \-depth " depth"
  93 requests a specific depth. Try "\fB-depth\fR best" or "\fB-depth\fR
  94 8" if you get a bad match.
  95 .TP
  96 .BI \-debug " level"
  97 generates some info about the state of the
  98 .B XForms.
  99 where
 100 .I level
 101 is an integer between 1-5 and controls the amount of
 102 information to output. Depending on the options used
 103 when the
 104 .B Forms Library
 105 was built, a level more than 3 might not be available.
 106 .TP
 107 .B \-sync
 108 runs the application in synchronous mode with debug level set to 4.
 109 .TP
 110 .B \-private
 111 requests a private colormap for the application.
 112 .TP
 113 .B \-shared
 114 requests a shared colormap even if the application needs more
 115 colors than available. For those colors that can't be allocated
 116 in the shared colormap, substitutions are made so the closest
 117 matching color is used.
 118 .TP
 119 .B \-stdcmap
 120 requests a standard colormap.
 121 .TP
 122 .B \-name " newname"
 123 specifies the application name under which resources are to be
 124 obtained, rather than the default executable file name.
 125 .SH ENVIRONMENT
 126 .TP
 127 .B LYX_DIR_12x
 128 can be used to specify which system directory to use.
 129 .PP
 130 The system directory is determined by searching for the file
 131 "chkconfig.ltx". Directories are searched in this order:
 132 .br
 133 1) -sysdir command line parameter
 134 .br
 135 2) LYX_DIR_12x environment variable
 136 .br
 137 3) Maybe <path of binary>/TOP_SRCDIR/lib
 138 .br
 139 4) <path of binary>/../share/<name of binary>/
 140 .br
 141 5) hardcoded lyx_dir (usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree)
 142 .TP
 143 .B LYX_USERDIR_12x
 144 can be used to specify which user directory to use.
 145 .PP
 146 The user directory is, in order of precedence:
 147 .br
 148 1) -userdir command line parameter
 149 .br
 150 2) LYX_USERDIR_12x environment variable
 151 .br
 152 3) $HOME/.<name of binary> if no explicit setting is made
 153
 154 .TP
 155 .B LYX_LOCALEDIR
 156 can be used to tell LyX where to look for the translations of its GUI
 157 strings in other languages.
 158 .SH FILES
 159 .nf
 160 .ta \w'\fILIBDIR\fR/lyxrc.in  'u
 161 ~/.lyx/lyxrc      Personal configuration file
 162 \fILIBDIR\fR/lyxrc      System wide configuration file
 163 \fILIBDIR\fR/lyxrc.example System wide configuration file template
 164 \fILIBDIR\fR/configure  Updates \fBLyX\fR if config has changed
 165 \fILIBDIR\fR/bind/      Keybindings
 166 \fILIBDIR\fR/clipart/   Clipart pictures
 167 \fILIBDIR\fR/doc/       Documentation in \fBLyX\fR format.
 168 \fILIBDIR\fR/examples/  Example documents
 169 \fILIBDIR\fR/images/    Images used as icons or in popups
 170 \fILIBDIR\fR/kbd/       Keyboard mappings
 171 \fILIBDIR\fR/layouts/   Layout descriptions
 172 \fILIBDIR\fR/templates/ Templates for documents
 173 \fILIBDIR\fR/tex/       Extra TeX files
 174 .Sp
 175 .fi
 176
 177 .I LIBDIR
 178 is the system directory. This is usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree.
 179 .SH SEE ALSO
 180 reLyX(1), latex(1), xforms(5).
 181
 182 Full documentation in either native \fBLyX\fR or postscript format.
 183 .SH BUGS/LIMITATIONS
 184 There are still some bugs in \fBLyX\fR. To report one, read if
 185 possible the Introduction found under the Help menu in LyX. You'll
 186 find detailed info on submitting bug reports there. If you can't do
 187 that, send details to the LyX Developers mailing list
 188 lyx-devel@lists.lyx.org, or use the LyX bug tracker at
 189 http://bugzilla.lyx.org/. Don't forget to mention which version you
 190 are having problems with!
 191
 192 \fBLaTeX\fR import is still not perfect and may produce buggy *.lyx
 193 files. Consult the \fBreLyX\fR documentation.
 194
 195 XFree on OS/2 currently does not support PC codepages. If you use
 196 \fBemTeX\fR to preview/print with cp850, etc., this might lead to
 197 strange \fBemTeX\fR error messages.
 198 .B Remedy:
 199   1) In filenames use only A-Z, a-z, 1-9.
 200   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}'.
 201
 202 \fBLyX\fR server has some limitations under OS/2: See
 203 Help->Customization for details.
 204
 205 Preview of inline images in rare cases does not show the image. If you
 206 want to preview the image, just click on it and choose fullscreen
 207 preview.
 208
 209 If you have performance problems, please go through the
 210 Edit>Preferences... dialog. It contains settings that can be used to
 211 improve performance on slow systems.
 212 .SH AUTHORS
 213 Copyright
 214 .Cr
 215 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 by Matthias Ettrich
 216 (ettrich@informatik.uni-tuebingen.de) and the rest of the \fBLyX
 217 Team\fR (See Credits under the Help menu item).