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