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 \-i [\-\-import]\fP \fIfmt file.xxx
  75 where fmt is the import format of choice and file.xxx is the file to be imported.
  76 .TP
  77 \fB \-f [\-\-force\-overwrite]\fP \fIwhat
  78 where what is is either "\fBall\fR" or "\fBmain\fR".
  79 Using "\fBall\fR", all files are overwritten during a batch export, otherwise
  80 only the main file will be. When this switch is followed by anything else other
  81 than "\fBall\fR" or "\fBmain\fR", the behavior is as if "\fBall\fR" was
  82 specified, but what follows is left on the command line for further processing.
  83 .TP
  84 .BI -batch
  85 causes LyX to run the given commands without opening a GUI window.
  86 Thus, something like:
  87 .br
  88     lyx -batch -x "buffer-print printer default dvips" myfile.lyx
  89 .br
  90 will cause LyX to print myfile.lyx to the default printer, using dvips and
  91 the default print settings (which, of course, have to have been configured
  92 already).
  93
  94 .SH ENVIRONMENT
  95 .TP
  96 .B @LYX_DIR_VER@
  97 can be used to specify which system directory to use.
  98 .PP
  99 The system directory is determined by searching for the file
 100 "chkconfig.ltx". Directories are searched in this order:
 101 .br
 102 1) \-sysdir command line parameter
 103 .br
 104 2) @LYX_DIR_VER@ environment variable
 105 .br
 106 3) Maybe <path of binary>/TOP_SRCDIR/lib
 107 .br
 108 4) <path of binary>/../share/<name of binary>/
 109 .br
 110 5) hardcoded lyx_dir (at build time: @real_pkgdatadir@)
 111 .TP
 112 .B @LYX_USERDIR_VER@
 113 can be used to specify which user directory to use.
 114 .PP
 115 The user directory is, in order of precedence:
 116 .br
 117 1) \-userdir command line parameter
 118 .br
 119 2) @LYX_USERDIR_VER@ environment variable
 120 .br
 121 3) $HOME/.<name of binary> if no explicit setting is made
 122
 123 .TP
 124 .B LYX_LOCALEDIR
 125 can be used to tell LyX where to look for the translations of its GUI
 126 strings in other languages.
 127 .SH FILES
 128 .nf
 129 .ta \w'\fILIBDIR\fR/lyxrc.in  'u
 130 ~/.lyx/preferences      Personal configuration file
 131 ~/.lyx/lyxrc.defaults   Personal autodetected configuration file
 132 \fILIBDIR\fR/lyxrc.dist  System wide configuration file
 133 \fILIBDIR\fR/configure.py  Updates \fBLyX\fR if config has changed
 134 \fILIBDIR\fR/bind/      Keybindings
 135 \fILIBDIR\fR/clipart/   Clipart pictures
 136 \fILIBDIR\fR/doc/       Documentation in \fBLyX\fR format.
 137 \fILIBDIR\fR/examples/  Example documents
 138 \fILIBDIR\fR/images/    Images used as icons or in popups
 139 \fILIBDIR\fR/kbd/       Keyboard mappings
 140 \fILIBDIR\fR/layouts/   Layout descriptions
 141 \fILIBDIR\fR/templates/ Templates for documents
 142 \fILIBDIR\fR/tex/       Extra TeX files
 143 .sp
 144 .fi
 145
 146 .I LIBDIR
 147 is the system directory. This was at build time @real_pkgdatadir@.
 148 .SH SEE ALSO
 149 tex2lyx@version_suffix@(1), latex(1).
 150
 151 Full documentation in either native \fBLyX\fR or postscript format.
 152 .SH BUGS/LIMITATIONS
 153 There are still some bugs in \fBLyX\fR. To report one, read if
 154 possible the Introduction found under the Help menu in LyX. You'll
 155 find detailed info on submitting bug reports there. If you can't do
 156 that, send details to the LyX Developers mailing list
 157 lyx\-devel@lists.lyx.org, or use the LyX bug tracker at
 158 http://bugzilla.lyx.org/. Don't forget to mention which version you
 159 are having problems with!
 160
 161 \fBLaTeX\fR import is still not perfect and may produce buggy *.lyx
 162 files. Consult the \fBtex2lyx@version_suffix@\fR documentation.
 163
 164 .SH AUTHORS
 165 LyX is Copyright (C) 1995 by Matthias Ettrich, 1995-2010 LyX Team