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