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, Compaq
  36 Tru64, 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 .SH OPTIONS
  40 \fBLyX\fR supports the following command-line switches, which can also
  41 be specified as X resources (e. g. in .Xdefaults) with class
  42 name \fBLyX\fR:
  43 .TP 6
  44 .BI \-help
  45 summarizes LyX usage
  46 .TP
  47 .BI \-version
  48 provides version information on the build of LyX.
  49 .TP
  50 .BI \-sysdir " directory"
  51 sets system directory. Normally not needed.
  52 .TP
  53 .BI \-userdir " directory"
  54 sets user directory. Needed if you want to use LyX with different lyxrc
  55 settings.
  56 .TP
  57 .BI \-geometry " WxH+X+Y"
  58 specifies the preferred size and position of the main \fBLyX\fR window; see \fIX(1)\fR.
  59 .TP
  60 .BI \-dbg " feature[,feature...]"
  61 where feature is a name or number.
  62 Use "\fBlyx -dbg\fR" to see the list of available debug features.
  63 .TP
  64 \fB -x [--execute]\fP \fIcommand
  65 where command is a lyx command.
  66 .TP
  67 \fB -e [--export]\fP \fIfmt
  68 where fmt is the export format of choice.
  69 .TP
  70 \fB -i [--import]\fP \fIfmt file.xxx
  71 where fmt is the import format of choice and file.xxx is the file to be imported.
  72
  73 .PP
  74 Furthermore, \fBLyX\fR understands the following generic command line options
  75 from the \fBForms Library\fR:
  76 .TP 6
  77 .BI \-display " host:display"
  78 specifies the server to connect to.
  79 .TP
  80 .BI \-bw " borderwidth"
  81 specifies the border width to use to built-in objects.
  82 .TP
  83 .BI \-visual " visualName"
  84 requests a visual by name such as TrueColor etc. By default the
  85 .B Forms Library
  86 always selects the visual that has the most depth.
  87 .TP
  88 .BI \-depth " depth"
  89 requests a specific depth. Try "\fB-depth\fR best" or "\fB-depth\fR
  90 8" if you get a bad match.
  91 .TP
  92 .BI \-debug " level"
  93 generates some info about the state of the
  94 .B XForms.
  95 where
  96 .I level
  97 is an integer between 1-5 and controls the amount of
  98 information to output. Depending on the options used
  99 when the
 100 .B Forms Library
 101 was built, a level more than 3 might not be available.
 102 .TP
 103 .B \-sync
 104 runs the application in synchronous mode with debug level set to 4.
 105 .TP
 106 .B \-private
 107 requests a private colormap for the application.
 108 .TP
 109 .B \-shared
 110 requests a shared colormap even if the application needs more
 111 colors than available. For those colors that can't be allocated
 112 in the shared colormap, substitutions are made so the closest
 113 matching color is used.
 114 .TP
 115 .B \-stdcmap
 116 requests a standard colormap.
 117 .TP
 118 .B \-name " newname"
 119 specifies the application name under which resources are to be
 120 obtained, rather than the default executable file name.
 121 .SH ENVIRONMENT
 122 .TP
 123 .B LYX_DIR_11x
 124 can be used to specify which system directory to use.
 125 .PP
 126 The system directory is determined by searching for the file
 127 "chkconfig.ltx". Directories are searched in this order:
 128 .br
 129 1) -sysdir command line parameter
 130 .br
 131 2) LYX_DIR_11x environment variable
 132 .br
 133 3) Maybe <path of binary>/TOP_SRCDIR/lib
 134 .br
 135 4) <path of binary>/../share/<name of binary>/
 136 .br
 137 5) hardcoded lyx_dir (usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree)
 138 .TP
 139 .B LYX_USERDIR_11x
 140 can be used to specify which user directory to use.
 141 .PP
 142 The user directory is, in order of precedence:
 143 .br
 144 1) -userdir command line parameter
 145 .br
 146 2) LYX_USERDIR_11x environment variable
 147 .br
 148 3) $HOME/.<name of binary> if no explicit setting is made
 149
 150 .TP
 151 .B LYX_LOCALEDIR
 152 can be used to tell LyX where to look for the translations of its GUI
 153 strings in other languages.
 154 .SH FILES
 155 .nf
 156 .ta \w'\fILIBDIR\fR/lyxrc.in  'u
 157 ~/.lyx/lyxrc      Personal configuration file
 158 \fILIBDIR\fR/lyxrc      System wide configuration file
 159 \fILIBDIR\fR/lyxrc.example System wide configuration file template
 160 \fILIBDIR\fR/configure  Updates \fBLyX\fR if config has changed
 161 \fILIBDIR\fR/bind/      Keybindings
 162 \fILIBDIR\fR/clipart/   Clipart pictures
 163 \fILIBDIR\fR/doc/       Documentation in \fBLyX\fR format.
 164 \fILIBDIR\fR/examples/  Example documents
 165 \fILIBDIR\fR/images/    Images used as icons or in popups
 166 \fILIBDIR\fR/kbd/       Keyboard mappings
 167 \fILIBDIR\fR/layouts/   Layout descriptions
 168 \fILIBDIR\fR/templates/ Templates for documents
 169 \fILIBDIR\fR/tex/       Extra TeX files
 170 .Sp
 171 .fi
 172
 173 .I LIBDIR
 174 is the system directory. This is usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree.
 175 .SH SEE ALSO
 176 reLyX(1), latex(1), xforms(5).
 177
 178 Full documentation in either native \fBLyX\fR or postscript format.
 179 .SH BUGS/LIMITATIONS
 180 There are probably still some bugs in \fBLyX\fR. Please report them to
 181 lyx-devel@lists.lyx.org with detailed info, including which version of
 182 \fBLyX\fR you use. Consult the bug-reporting instructions in the
 183 Introduction (accessible from the Help menu in LyX) first if possible.
 184
 185 \fBLaTeX\fR import is still not perfect and may produce buggy *.lyx
 186 files. Consult the \fBreLyX\fR documentation.
 187
 188 XFree on OS/2 currently does not support PC codepages. If you use
 189 \fBemTeX\fR to preview/print with cp850, etc., this might lead to
 190 strange \fBemTeX\fR error messages.
 191 .B Remedy:
 192   1) In filenames use only A-Z, a-z, 1-9.
 193   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}'.
 194
 195 \fBLyX\fR server has some limitations under OS/2: See
 196 Help->Customization for details.
 197
 198 Preview of inline images in rare cases does not show the image. If you
 199 want to preview the image, just click on it and choose fullscreen
 200 preview.
 201
 202 If you have performance problems, please go through the \fBlyxrc\fR
 203 configuration file. It contains settings that can be used to improve
 204 performance on slow systems.
 205 .SH AUTHORS
 206 Copyright
 207 .Cr
 208 1995, 1996, 1997, 1998, 1999 by Matthias Ettrich
 209 (ettrich@informatik.uni-tuebingen.de) and the rest of the \fBLyX
 210 Team\fR (See Credits under the Help menu item).