lyx.1in

   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 "@LYX_DATE@" "Version @VERSION@" "LyX @VERSION@"
   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@version_suffix@\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 the Qt4 library as a
  40 toolkit. \fBLyX\fR should run everywhere, where this library runs.
  41 This is on all major Unix platforms as well as Windows and Mac OS X
  42 (which actually is a unix platform).
  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 \-geometry " WxH+X+Y"
  60 set geometry of the main window.
  61 .TP
  62 .BI \-dbg " feature[,feature...]"
  63 where feature is a name or number.
  64 Use "\fBlyx@version_suffix@ \-dbg\fR" to see the list of available debug features.
  65 .TP
  66 \fB \-x [\-\-execute]\fP \fIcommand
  67 where command is a lyx command.
  68 .TP
  69 \fB \-e [\-\-export]\fP \fIfmt
  70 where fmt is the export format of choice.
  71 Look on Tools->Preferences->File formats->Format to get an idea which parameters should be passed.
  72 Note that the order of \-e and \-x switches matters.
  73 .TP
  74 \fB \-E [\-\-export\-to]\fP \fIfmt \fIfilename
  75 where fmt is the export format of choice (see \-\-export),
  76 and filename is the destination filename.
  77 .TP
  78 \fB \-i [\-\-import]\fP \fIfmt file.xxx
  79 where fmt is the import format of choice and file.xxx is the file to be imported.
  80 .TP
  81 \fB \-f [\-\-force\-overwrite]\fP \fIwhat
  82 where what is is either "\fBall\fR", "\fBmain\fR" or "\fBnone\fR".
  83 Specify "\fBall\fR" to allow overwriting all files during a batch export,
  84 "\fBmain\fR" to allow overwriting the main file only, or "\fBnone\fR"
  85 to disallow overwriting any file. When this switch is followed by anything
  86 else other than "\fBall\fR", "\fBmain\fR" or "\fBnone\fR", the behavior is as
  87 if "\fBall\fR" was specified, but what follows is left on the command line for
  88 further processing.
  89 .TP
  90 \fB \-n [\-\-no\-remote]\fP
  91 open documents passed as arguments in a new instance, even if another
  92 instance of LyX is already running.
  93 .TP
  94 \fB \-r [\-\-remote]\fP
  95 by using the lyxpipe, ask an already running instance of LyX to open the
  96 documents passed as arguments and then exit. If the lyxpipe is not set up or
  97 is not working, a new instance is created and execution continues normally.
  98 .TP
  99 .BI \-batch
 100 causes LyX to run the given commands without opening a GUI window.
 101 Thus, something like:
 102 .br
 103     lyx \-batch \-x "buffer\-print printer default dvips" myfile.lyx
 104 .br
 105 will cause LyX to print myfile.lyx to the default printer, using dvips and
 106 the default print settings (which, of course, have to have been configured
 107 already).
 108
 109 .SH ENVIRONMENT
 110 .TP
 111 .B @LYX_DIR_VER@
 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_VER@ 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 (at build time: @real_pkgdatadir@)
 126 .TP
 127 .B @LYX_USERDIR_VER@
 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_VER@ 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
 143 .TP
 144 .B LYX_FORCE_OVERWRITE
 145 can be used to change the default behavior when exporting from command
 146 line.
 147 .PP
 148 By default, LyX overwrites the main file when exporting from command
 149 line but not the ancillary files. This behavior can be changed by setting
 150 this environment variable, which relieves the need of using the \-f switch.
 151 Allowed values are either "\fBall\fR", "\fBmain\fR" or "\fBnone\fR", with
 152 same meaning as for the \-f switch.
 153 .SH FILES
 154 .nf
 155 .ta \w'\fILIBDIR\fR/lyxrc.in  'u
 156 ~/.lyx/preferences      Personal configuration file
 157 ~/.lyx/lyxrc.defaults   Personal autodetected configuration file
 158 \fILIBDIR\fR/lyxrc.dist  System wide configuration file
 159 \fILIBDIR\fR/configure.py  Updates \fBLyX\fR if config has changed
 160 \fILIBDIR\fR/bind/      Keybindings
 161 \fILIBDIR\fR/clipart/   Clipart pictures
 162 \fILIBDIR\fR/doc/       Documentation in \fBLyX\fR format.
 163 \fILIBDIR\fR/examples/  Example documents
 164 \fILIBDIR\fR/images/    Images used as icons or in popups
 165 \fILIBDIR\fR/kbd/       Keyboard mappings
 166 \fILIBDIR\fR/layouts/   Layout descriptions
 167 \fILIBDIR\fR/templates/ Templates for documents
 168 \fILIBDIR\fR/tex/       Extra TeX files
 169 .sp
 170 .fi
 171
 172 .I LIBDIR
 173 is the system directory. This was at build time @real_pkgdatadir@.
 174 .SH SEE ALSO
 175 tex2lyx@version_suffix@(1), latex(1).
 176
 177 Full documentation in either native \fBLyX\fR or postscript format.
 178 .SH BUGS/LIMITATIONS
 179 There are still some bugs in \fBLyX\fR. To report one, read if
 180 possible the Introduction found under the Help menu in LyX. You'll
 181 find detailed info on submitting bug reports there. If you can't do
 182 that, send details to the LyX Developers mailing list
 183 lyx\-devel@lists.lyx.org, or use the LyX bug tracker at
 184 http://bugzilla.lyx.org/. Don't forget to mention which version you
 185 are having problems with!
 186
 187 \fBLaTeX\fR import is still not perfect and may produce buggy *.lyx
 188 files. Consult the \fBtex2lyx@version_suffix@\fR documentation.
 189
 190 .SH AUTHORS
 191 LyX is Copyright (C) 1995 by Matthias Ettrich, 1995-2010 LyX Team