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