]> git.lyx.org Git - lyx.git/blobdiff - lib/lyxrc.example
fix typo that put too many include paths for most people
[lyx.git] / lib / lyxrc.example
index e41ac1bd097eb421f302dff3b621bb680b55f287..c9bab7030230373db93ee7758cd174024c00b304 100644 (file)
 # We recommend to keep the confirmation, though.
 #\exit_confirmation false
 
+# This sets the behaviour if you want to be asked for a filename when
+# creating a new document or wait until you save it and be asked then.
+# The default for now is ask on save.
+# \new_ask_filename false
+
 # LyX continously displays names of last command executed, along with a list 
 # of defined short-cuts for it in the minibuffer.
 # It requires some horsepower to function, so you can turn it off, if LyX
 # seems slow to you, by uncommenting this line:
 #\display_shortcuts false
 
-# Define which program to use to view dvi files here.
-# You can include any options you need by "quoting" the entire command.
-# The default is "xdvi".
-# Example: the next line would use xdvi and display with shrink 2:
-#\view_dvi_command "xdvi -s 2"
-# It can get more involved. Expert users might prefer something like:
-#\view_dvi_command "xdvi -s 2 -expert -geometry 1014x720+0+0 -keep -margins 1.5"
-
 # \view_dvi_paper_option allows to specify a paper option to the dvi
 # viewer. By default LyX specifies the paper size of the document to
 # the dvi viewer via the command line option -paper size, where size
 # executive, a3, a4, a5, or b5 as the default papersize.
 #\default_papersize "a4"
 
-# Define which program to use to view pdf files here.
-# You can include any options you need by "quoting" the entire command
-# The default is auto-detected, but you might want to override it.
-# Usual values are: xpdf, acroread, gv, ghostscript.
-#\view_pdf_command "xpdf"
-
-# Define which program to use to view postscript files here.
-# You can include any options you need by "quoting" the entire command
-# The default is auto-detected, but you might want to override it.
-# It is possible to get nice anti-aliased text (slower, but as nice as
-# xdvi) by using something like
-#\view_ps_command "ghostview -swap -sDEVICE=x11alpha"
-
-# Define which program to use to full screen view included postscript
-# pictures. You can not include any options. The default is auto-detected.
-#\view_pspic_command ghostview
-
 # Define which program to use to use as postscript interpreter for included
 # images.
 # You can not include any options. The default is "gs" if it can be found.
 # Example: use this to ignore warnings about using "\ldots" instead of "..."
 #\chktex_command "chktex -n11 -n1 -n3 -n6 -n9 -22 -n25 -n30 -n38"
 
-# Define which program to use to translate latex to HTML.
-# You should include options. The default is autodetected: the programs 
-# checked are tth, latex2html and hevea, and the default command lines
-# used are:  
-#\html_command "tth -t < '$$FName' > '$$OutName'"
-#\html_command "latex2html -no_subdir -split 0 -show_section_numbers '$$FName'"
-#\html_command "hevea -s '$$FName'"
-# The variable name $$FName is replaced with the name of the .tex
-# file, and $$OutName is replaced with the name of the html file.
-# Example: use this to let math be italic with tth.
-#\html_command "tth -t -i < '$$FName' > '$$OutName'"
-
 # Keyboard Mapping. Use this to set the correct mapping file for your
 # keyboard, that is if you need one. You'll need one if you for instance
 # want to type German documents on an American keyboard. In that case,
 # '.in' and '.out'. Only for advanced users.
 # \serverpipe "/home/chb/.lyxpipe"
 
-# Which command to use to invoke the reLyX script to convert
-# LaTeX files to LyX files.  This setting is automatically
-# disabled if you do not have the appropriate Perl version
-# installed.  In that case, the File->Import LaTeX command
-# will be disabled.  If the reLyX command does work for you,
-# you can override that here by uncommenting this line:
-#\relyx_command "reLyX"
+# Default format string for the date-insert command
+#
+# This accepts the normal strftime formats; see man strftime for full
+# details of the format.
+#
+#\date_insert_format "%A, %e. %B %Y"
+
+
+# Maximum number of words in the initialization string for a new label.
+# If it is set to 0, then the init. string will only contain the prefix
+# (e.g. "sec:"). If it is set to -1, the init. string will be empty. 
+# This feature is disabled in 1.1.6.
 #
-# If it doesn't work, you can disable the command by uncommenting
-# this line:
-#\relyx_command "none"
+#\label_init_length 0
 
 #
 # SCREEN & FONTS SECTION #################################################
 # is 150%.
 #\screen_zoom 100
 
+# The wheel movement factor (for mice with wheels or five button mice)
+# Default is 100, about a page down. A value of 10 give me about a line and
+# a half
+#\wheel_jump 10
+
 # LyX normally doesn't update the cursor position if you move the scrollbar.
 # If you scroll the cursor off the screen and then start typing LyX will
 # move you back to where the cursor was. If you'd prefer to always have the 
 # the same as what LaTeX calls latin1.
 #\screen_font_encoding iso8859-2
 
-# The font for popups. It is set to 
+# The norm for the popup fonts. The default is an empty string, which
+# causes to use the screen fonts norm (defined by \screen_font_encoding).
+#\popup_font_encoding iso8859-2
+
+
+# The normal font for popups. It is set to 
 #    <font_popup>-*-*-*-?-*-*-*-*-<font_encoding>.
 # The default  is:
-#\screen_font_popup "-*-helvetica-medium-r"
+#\popup_font_name "-*-helvetica-medium-r"
 
-# The font for menus (and groups titles in popups). It is set to 
+# The bold font for popups. It is set to 
 #    <font_menu>-*-*-*-?-*-*-*-*-<font_encoding>.
 # The default  is:
-#\screen_font_menu "-*-helvetica-bold-r"
+#\popup_bold_font "-*-helvetica-bold-r"
 
 # The font sizes used for calculating the scaling of the screen fonts.
 # You should only have to change these if the fonts on your screen look bad,
 # This is the default in LyX (exactly what LaTeX does):
 #\screen_font_sizes 5.0 7.0 8.0 9.0 10.0 12.0 14.4 17.28 20.74 24.88
 
+# To change the colors for footnotes:
+#\set_color footnote green
+# for mathed you may also want to change the coloring of lines and brackets:
+#\set_color math yellow
+#\set_color mathlines yellow
+
+#
+# UI SECTION ########################################################
 #
-# TOOLBAR SECTION ########################################################
-#
-
-# Setup your favorite Toolbar here:
-# Only three commands are allowed inside the begin_toolbar and end_toolbar
-# directives: 
-#   \add <action> [<parameter>] adds an icon to the toolbar performing
-#          "<action> <parameter>"
-#      Examples:
-#      \add font-size small
-#      \add set-emph
-#
-#   \layouts adds the layouts combo-box to the toolbar
-#
-#   \separator adds some spacing to the toolbar
-#
-# These actions have icons (please give us more :-):
-#   buffer-open, buffer-close, buffer-print, buffer-write, font-emph,
-#   font-noun, font-free, footnote-insert, depth-next, copy, cut, paste,
-#   tex-mode, math-mode, marginpar-insert, figure-insert, table-insert,
-#   melt, lyx-quit, buffer-export ascii|latex, font-bold, font-sans, 
-#   buffer-typeset, buffer-view, buffer-view-ps, symbol_insert [parameter]
-#
-#  All other lyx commands will get a "unknown" icon.
-#
-# This is the default toolbar:
-#\begin_toolbar
-#\layouts
-#\add buffer-open
-#\add buffer-write
-#\add buffer-print
-#\separator
-#\add cut
-#\add copy
-#\add paste
-#\separator
-#\add font-emph
-#\add font-noun
-#\add font-free
-#\separator
-#\add footnote-insert
-#\add marginpar-insert
-#\add depth-next
-#\separator
-#\add tex-mode
-#\add math-mode
-#\separator
-#\add figure-insert
-#\add table-insert
-#\end_toolbar
+
+# Choose your UI (user interface) definition here. The .ui files are in the 
+# directory "lib/ui" and contains the definition of the menu and the toolbar.
+#\ui_file "default"
 
 #
 # PRINTER SECTION ########################################################
 #\print_collcopies_flag -c
 #\print_adapt_output false
 
-
 #
 # EXPORT SECTION ########################################################
 #
 
-
-# With this you can send a LyX-Document to a User-defined program. You
-# can specify by adding the tag $$FName where the filename should be
-# put on the defined command. if no $$FName is specified the file is
-# sent in standard input (stdin). There is no default command
-# specified.  Example: 
-#\custom_export_command "kghostview $$FName"
-#
-# A more elaborate example to create pdf files with ps2pdf would be: 
-#\custom_export_command "ps2pdf '$$FName' `basename '$$FName' .ps_tmp`.pdf"  
-
-
-# This is the default for the type of contents to be sent to the export
-# command: possible values are lyx, dvi, tex, ps and ascii.
-#\custom_export_format ps
+# The \converter command defines a converter between two formats. 
+# LyX uses the defined converters for generating output in various formats,
+# or for importing.
+# The converter command has 4 arguments: The source format, the target format,
+# the command, and additional flags.
+# For example, the following defines a DVI->Postscript converter:
+#\converter dvi ps "dvips -o $$o $$i" ""
+# The variable name $$i is replaced with the name of the source file,
+# and $$o is replaced with the name of the target file.
+# The flags argument is a list of comma separated flags.
+# Known flags are
+# - * : copy the previously defined flags
+# - latex : The converter is latex or its derivatives (pdflatex).
+# - originaldir : The converter must be invoked in the directory of the lyx
+#   file and not in the temporary directory. This is needed for tex->html
+#   converters in order to be able to read the eps files.
+# - needaux : The converted uses the .aux file, so we need to call latex
+#   before running the converter.
+# - resultdir=dir : The converter put all the files in dir.
+#   Using "resultdir" is same as "resultdir=$$b".
+#   Note: When exporting, the whole directory will be moved from the temporary
+#   directory to the target directory.
+# - resultfile=file : Name of main file in the result directory, for example
+#  "index.html" or "$$b.html"
+#   If "resultfile" is omitted, the name of this file is assumed to be
+#   "index.format"
+# - parselog=filtername : filtername is a name of a filter command that takes
+#   the converter error log (from stderr), and converts it to a fake latex .log
+#   file.
+# For example:
+#\converter latex html "latex2html -split 0 $$i"
+#           "originaldir,needaux,resultdir"
+#
+# For literate programming, use something like
+#\converter literate latex "noweave -delay -index $$i >$$o"
+#                          "parselog=listerrors g"
+#\converter literate program "build-script $$i"
+#                            "originaldir,parselog=listerrors g"
+
+# The format command is used to define file formats. It has 4 arguments:
+# the format name, the extension, and "pretty name" and menu shortcut.
+# For example
+#\Format latex tex LaTeX L
+
+# The \viewer command is used to define viewers for new formats,
+# or to change the already defined viewers.
+# For example, to use xdvi as the viewer to dvi files use
+#\viewer dvi "xdvi"
+# It can get more involved. Expert users might prefer something like:
+#\viewer dvi "xdvi -s 2 -expert -geometry 1014x720+0+0 -keep -margins 1.5"
 
 #
 # TEX SECTION  ###########################################################
 #
 
-# LyX tries to auto-detect which command to use to invoke LaTeX(2e).
-# If the auto-detection for some reasons fail, you can override it
-# here:
-#\latex_command latex2e
-
-# The command used to generate pdf files directly from a latex file.
-# A program that works in anyother way is not guarantied to work.
-#\pdflatex_command pdflatex
-
-# The command used to generate postscript files from pdf files.
-#\pdf_to_ps_command pdf2ps
-
-# If to use pdf as native export format instead of dvi. This makes LyX use
-# pdflatex, pdf2ps and other utility programs. Default is false.
-#\pdf_mode false
-
 # The font encoding used for the LaTeX2e fontenc package.
 # T1 is highly recommended for non-English languages. LyX uses T1 as a
 # default if you have the ec fonts installed on your system.
 # Choose "default" if T1 doesn't work for you for some reason:
 #\font_encoding default
 
-
-#
-# LINUXDOC SECTION #######################################################
-#
-
-# If you want to pass extra flags to the LinuxDoc sgml scripts, insert them
-# here. 
-# Example: the next line activates iso-latin1 support:
-#\linuxdoc_to_latex_command "sgml2latex -c latin"
-
-# Here you have the command to convert from linuxdoc to html.
-# Example: one html file only.
-#\linuxdoc_to_html_command "sgml2html -s 0 '$$FName'"
-
-# The LinuxDoc to LyX converter
-#\linuxdoc_to_lyx_command "sgml2lyx"
-
-#
-# DOCBOOK SECTION ########################################################
-#
-
-# Command to convert a docbook file to dvi
-#\docbook_to_dvi_command "sgmltools -b dvi"
-
-# Command to convert a docbook file to html
-#\docbook_to_html_command "sgmltools -b html '$$FName'"
-
-# Command to convert a docbook file to pdf
-#\docbook_to_pdf_command ""
-
-
 #
 # FILE SECTION  ##########################################################
 #
 # Default is "".
 #\backupdir_path "~/Desktop/Trash/"
 
-
-#
-# FAX SECTION #############################################################
-#
-
-# In the following, the <$$something> strings are substituted by
-# reasonable values by LyX. The 's are important as there may be spaces in 
-# the string. The default is auto-detected.
-# This one is what is used with HylaFax:
-#\fax_command "sendfax -n -h '$$Host' -c '$$Comment' -x '$$Enterprise' -d '$$Name'@'$$Phone' '$$FName'"
-# Use this for the efax-command:
-#\fax_command "faxsend '$$Phone' '$$FName'"
-
-# This is the name of your phone book. It's per default situated in ~/.lyx/,
-# but you can override that with an absolute path.
-#\phone_book phonebook
-
-# This is how to call an external FAX-program instead of the built-in.
-# You may also insert $$FName to reference the PostScript file.
-#\fax_program "myfaxprg '$$FName'"
-#\fax_program tkhylafax
-
 #
 # ASCII EXPORT SECTION ###################################################
 #
 # does not work with all dictionaries, so this is disabled by default.
 #\use_input_encoding true
 
-# Default format string for the date-insert command
-#
-# This accepts the normal strftime formats; see man strftime for full
-# details of the format.
-#
-#\date_insert_format "%A, %e. %B %Y"
 
 #
 # LANGUAGE SUPPORT SECTION ####################################################
 # Default is "true"
 #\mark_foreign_language false
 
+# It is possible to bind keys for changing the language inside a document. 
+# For example, the following command will cause F12 to switch between French
+# and English in a French document, and in a document of other language it will
+# switch between that language and French.
+#\bind "F12" "language french"
+
 #
 # HEBREW SUPPORT SECTION ####################################################
 #
 #\kbmap true
 #\kbmap_primary null
 #\kbmap_secondary hebrew
-#\latex_command elatex
+#\converter tex dvi elatex ""
+#\converter tex pdf pdfelatex ""
 #\font_encoding default
 
 # You also need to bind a key for switching between Hebrew and English.