home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / lyx21041.zip / XFree86 / man / man1 / lyx.1 next >
Text File  |  1999-05-20  |  8KB  |  235 lines

  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 "October 1998" "Version 1.0" "LyX 1.0"
  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, DEC
  36. Alpha/OSF, 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.  
  40. .SH OPTIONS
  41. \fBLyX\fR supports the following command-line switches, which can also
  42. be specified as X resources (e. g. in .Xdefaults) with class
  43. name \fBLyX\fR:
  44. .TP 6
  45. .BI \-help
  46. summarizes LyX usage
  47. .TP
  48. .BI \-sysdir " directory"
  49. sets system directory. Normally not needed.
  50. .TP
  51. .BI \-width " x"
  52. the width of the main window in \fBLyX\fR.
  53. .TP
  54. .BI \-height " y"
  55. the height of the main window in \fBLyX\fR.
  56. .TP
  57. .BI \-xpos " x"
  58. the x position of the main window in \fBLyX\fR.
  59. .TP
  60. .BI \-ypos " y"
  61. the y position of the main window in \fBLyX\fR.
  62. Notice, you have to specify both 
  63. .BI \-xpos 
  64. and 
  65. .BI \-ypos 
  66. to obtain the
  67. desired effect. Negative positions are ignored. If no valid position
  68. is given, the main window is centered.
  69. .TP
  70. .BI \-dbg " debug-level"
  71. where debug-level is a sum of debugging options.
  72. Use "\fBlyx -dbg 65535 -help\fR" to see the different flags.
  73. .TP
  74. .BI \-Reverse
  75. swaps foreground and background colors.
  76. .TP
  77. .BI \-Mono
  78. runs \fBLyX\fR in black and white mode.
  79. .TP
  80. .BI \-FastSelection
  81. uses a fast black and white drawing routine for selections. If you use
  82. this, the switches BackgroundColor and SelectionColor are ignored.
  83. .PP
  84. The following options can be used to define the colors to use for
  85. different things:
  86. .TP
  87. .BI \-MathColor " color"
  88. .TP
  89. .BI \-MathFrameColor " color"
  90. .TP
  91. .BI \-FootColor " color"
  92. .TP
  93. .BI \-LabelColor " color"
  94. .TP
  95. .BI \-FillColor " color"
  96. .TP
  97. .BI \-NewLineColor " color"
  98. .TP
  99. .BI \-OnOffLineColor " color"
  100. .TP
  101. .BI \-LatexColor " color"
  102. .TP
  103. .BI \-NoteColor " color"
  104. .TP
  105. .BI \-LightedColor " color"
  106. .TP
  107. .BI \-BackgroundColor " color"
  108. .TP
  109. .BI \-SelectionColor " color"
  110. .PP
  111. Furthermore, \fBLyX\fR understands the following generic command line options 
  112. from the \fBForms Library\fR:
  113. .TP 6
  114. .BI \-display " host:display"
  115. specifies the server to connect to.
  116. .TP
  117. .BI \-bw " borderwidth"
  118. specifies the border width to use to built-in objects. 
  119. .TP
  120. .BI \-visual " visualName"
  121. requests a visual by name such as TrueColor etc. By default the
  122. .B Forms Library
  123. always selects the visual that has the most depth.
  124. .TP
  125. .BI \-depth " depth"
  126. requests a specific depth. Try "\fB-depth\fR best" or "\fB-depth\fR
  127. 8" if you get a bad match.
  128. .TP
  129. .BI \-debug " level"
  130. generates some info about the state of the
  131. .B XForms. 
  132. where 
  133. .I level
  134. is an integer between 1-5 and controls the amount of
  135. information to output. Depending on the options used
  136. when the
  137. .B Forms Library
  138. was built, a level more than 3 might not be available.
  139. .TP
  140. .B \-sync
  141. runs the application in synchronous mode with debug level set to 4. 
  142. .TP
  143. .B \-private
  144. requests a private colormap for the application.
  145. .TP
  146. .B \-shared
  147. requests a shared colormap even if the application needs more
  148. colors than available. For those colors that can't be allocated
  149. in the shared colormap, substitutions are made so the closest
  150. matching color is used.
  151. .TP
  152. .B \-stdcmap
  153. requests a standard colormap.
  154. .TP
  155. .B \-name " newname"
  156. specifies the application name under which resources are to be
  157. obtained, rather than the default executable file name. 
  158. .SH ENVIRONMENT
  159. .TP
  160. .B LYX_DIR_10x
  161. can be used to specify which system directory to use.
  162. .PP
  163. The system directory is determined by searching for the file
  164. "chkconfig.ltx". Directories are searched in this order:
  165. .br
  166. 1) -sysdir command line parameter
  167. .br
  168. 2) LYX_DIR_10x environment variable
  169. .br
  170. 3) Maybe <path of binary>/TOP_SRCDIR/lib
  171. .br
  172. 4) <path of binary>/../share/<name of binary>/ 
  173. .br
  174. 5) hardcoded lyx_dir (usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree)
  175.  
  176. .TP
  177. .B LYX_LOCALEDIR
  178. can be used to tell LyX where to look for the translations of its GUI
  179. strings in other languages.
  180.  
  181. .SH FILES
  182. .nf
  183. .ta \w'\fILIBDIR\fR/lyxrc.in  'u
  184. ~/.lyx/lyxrc      Personal configuration file
  185. \fILIBDIR\fR/lyxrc      System wide configuration file
  186. \fILIBDIR\fR/lyxrc.example System wide configuration file template
  187. \fILIBDIR\fR/configure  Updates \fBLyX\fR if config has changed
  188. \fILIBDIR\fR/bind/      Keybindings
  189. \fILIBDIR\fR/clipart/   Clipart pictures
  190. \fILIBDIR\fR/doc/       Documentation in \fBLyX\fR format.
  191. \fILIBDIR\fR/examples/  Example documents
  192. \fILIBDIR\fR/images/    Images used as icons or in popups
  193. \fILIBDIR\fR/kbd/       Keyboard mappings
  194. \fILIBDIR\fR/layouts/   Layout descriptions
  195. \fILIBDIR\fR/templates/ Templates for documents
  196. \fILIBDIR\fR/tex/       Extra TeX files
  197. .Sp
  198. .fi
  199.  
  200. .I LIBDIR
  201. is the system directory. This is usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree.
  202.  
  203. .SH SEE ALSO
  204. reLyX(1), latex(1), xforms(5).
  205.  
  206. Full documentation in either native \fBLyX\fR or postscript format.
  207. .SH BUGS/LIMITATIONS
  208. There are probably still some bugs in \fBLyX\fR. Please report them to
  209. lyx-devel@lists.lyx.org with detailed info, including which version of \fBLyX\fR
  210. you use.  Consult the "Known Bugs" item under the Help menu first if possible.
  211.  
  212. \fBLaTeX\fR import is still not perfect and may produce buggy *.lyx files. Consult the \fBreLyX\fR documentation.
  213.  
  214. XFree on OS/2 currently does not support PC codepages. If you use \fBemTeX\fR to preview/print with cp850, etc., this might lead to strange \fBemTeX\fR error messages.
  215. .B Remedy:
  216.   1) In filenames use only A-Z, a-z, 1-9.
  217.   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}'.
  218.  
  219. \fBLyX\fR server has some limitations under OS/2: See Help->Customization for details. 
  220.  
  221. Preview of inline images in rare cases does not show the image. If you want to preview the image, just click on it and choose fullscreen preview. 
  222.  
  223. If you have performance problems, please go through the \fBlyxrc\fR 
  224. configuration file.  It contains settings that can be used to improve 
  225. performance on slow systems.
  226.  
  227.  
  228.  
  229. .SH AUTHOR
  230. Copyright
  231. .Cr
  232. 1995, 1996, 1997, 1998 by Matthias Ettrich (ettrich@informatik.uni-tuebingen.de)
  233. and the rest of the \fBLyX Team\fR (See Credits under the Help menu
  234. item).
  235.