| 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 "Sept 2008" "Version 1.6" "LyX 1.6" |
|---|
| 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 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 \-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 |
.TP |
|---|
| 73 |
\fB \-i [\-\-import]\fP \fIfmt file.xxx |
|---|
| 74 |
where fmt is the import format of choice and file.xxx is the file to be imported. |
|---|
| 75 |
|
|---|
| 76 |
.SH ENVIRONMENT |
|---|
| 77 |
.TP |
|---|
| 78 |
.B @LYX_DIR_VER@ |
|---|
| 79 |
can be used to specify which system directory to use. |
|---|
| 80 |
.PP |
|---|
| 81 |
The system directory is determined by searching for the file |
|---|
| 82 |
"chkconfig.ltx". Directories are searched in this order: |
|---|
| 83 |
.br |
|---|
| 84 |
1) \-sysdir command line parameter |
|---|
| 85 |
.br |
|---|
| 86 |
2) @LYX_DIR_VER@ environment variable |
|---|
| 87 |
.br |
|---|
| 88 |
3) Maybe <path of binary>/TOP_SRCDIR/lib |
|---|
| 89 |
.br |
|---|
| 90 |
4) <path of binary>/../share/<name of binary>/ |
|---|
| 91 |
.br |
|---|
| 92 |
5) hardcoded lyx_dir (at build time: @real_pkgdatadir@) |
|---|
| 93 |
.TP |
|---|
| 94 |
.B @LYX_USERDIR_VER@ |
|---|
| 95 |
can be used to specify which user directory to use. |
|---|
| 96 |
.PP |
|---|
| 97 |
The user directory is, in order of precedence: |
|---|
| 98 |
.br |
|---|
| 99 |
1) \-userdir command line parameter |
|---|
| 100 |
.br |
|---|
| 101 |
2) @LYX_USERDIR_VER@ environment variable |
|---|
| 102 |
.br |
|---|
| 103 |
3) $HOME/.<name of binary> if no explicit setting is made |
|---|
| 104 |
|
|---|
| 105 |
.TP |
|---|
| 106 |
.B LYX_LOCALEDIR |
|---|
| 107 |
can be used to tell LyX where to look for the translations of its GUI |
|---|
| 108 |
strings in other languages. |
|---|
| 109 |
.SH FILES |
|---|
| 110 |
.nf |
|---|
| 111 |
.ta \w'\fILIBDIR\fR/lyxrc.in 'u |
|---|
| 112 |
~/.lyx/preferences Personal configuration file |
|---|
| 113 |
~/.lyx/lyxrc.defaults Personal autodetected configuration file |
|---|
| 114 |
\fILIBDIR\fR/lyxrc.dist System wide configuration file |
|---|
| 115 |
\fILIBDIR\fR/configure.py Updates \fBLyX\fR if config has changed |
|---|
| 116 |
\fILIBDIR\fR/bind/ Keybindings |
|---|
| 117 |
\fILIBDIR\fR/clipart/ Clipart pictures |
|---|
| 118 |
\fILIBDIR\fR/doc/ Documentation in \fBLyX\fR format. |
|---|
| 119 |
\fILIBDIR\fR/examples/ Example documents |
|---|
| 120 |
\fILIBDIR\fR/images/ Images used as icons or in popups |
|---|
| 121 |
\fILIBDIR\fR/kbd/ Keyboard mappings |
|---|
| 122 |
\fILIBDIR\fR/layouts/ Layout descriptions |
|---|
| 123 |
\fILIBDIR\fR/templates/ Templates for documents |
|---|
| 124 |
\fILIBDIR\fR/tex/ Extra TeX files |
|---|
| 125 |
.sp |
|---|
| 126 |
.fi |
|---|
| 127 |
|
|---|
| 128 |
.I LIBDIR |
|---|
| 129 |
is the system directory. This was at build time @real_pkgdatadir@. |
|---|
| 130 |
.SH SEE ALSO |
|---|
| 131 |
tex2lyx(1), latex(1). |
|---|
| 132 |
|
|---|
| 133 |
Full documentation in either native \fBLyX\fR or postscript format. |
|---|
| 134 |
.SH BUGS/LIMITATIONS |
|---|
| 135 |
There are still some bugs in \fBLyX\fR. To report one, read if |
|---|
| 136 |
possible the Introduction found under the Help menu in LyX. You'll |
|---|
| 137 |
find detailed info on submitting bug reports there. If you can't do |
|---|
| 138 |
that, send details to the LyX Developers mailing list |
|---|
| 139 |
lyx\-devel@lists.lyx.org, or use the LyX bug tracker at |
|---|
| 140 |
http://bugzilla.lyx.org/. Don't forget to mention which version you |
|---|
| 141 |
are having problems with! |
|---|
| 142 |
|
|---|
| 143 |
\fBLaTeX\fR import is still not perfect and may produce buggy *.lyx |
|---|
| 144 |
files. Consult the \fBtex2lyx\fR documentation. |
|---|
| 145 |
|
|---|
| 146 |
.SH AUTHORS |
|---|
| 147 |
LyX is Copyright (C) 1995 by Matthias Ettrich, 1995-2008 LyX Team |
|---|
