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