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