From 7c9f6a4afbde2d556ff913ba1a4f97a921b51ba6 Mon Sep 17 00:00:00 2001 From: Manuel Pégourié-Gonnard Date: Sun, 21 Feb 2010 14:14:42 +0000 Subject: Texdoc 0.65 with more flexibility in the list of configuration files. git-svn-id: svn://tug.org/texlive/trunk@17111 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf/doc/man/man1/texdoc.1 | 2 +- Master/texmf/doc/man/man1/texdoc.man1.pdf | Bin 5498 -> 5498 bytes Master/texmf/doc/texdoc/News | 6 +++ Master/texmf/doc/texdoc/texdoc.pdf | Bin 207918 -> 207519 bytes Master/texmf/doc/texdoc/texdoc.tex | 36 ++++++------- Master/texmf/scripts/texdoc/config.tlu | 24 +++++---- Master/texmf/scripts/texdoc/constants.tlu | 2 +- Master/texmf/scripts/texdoc/score.tlu | 1 + Master/texmf/texdoc/texdoc.cnf | 85 ++++++++++++++---------------- 9 files changed, 78 insertions(+), 78 deletions(-) diff --git a/Master/texmf/doc/man/man1/texdoc.1 b/Master/texmf/doc/man/man1/texdoc.1 index 6729b1acccc..940b658f8d0 100644 --- a/Master/texmf/doc/man/man1/texdoc.1 +++ b/Master/texmf/doc/man/man1/texdoc.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH TEXDOC "1" "February 2010" "texdoc 0.64" "User Commands" +.TH TEXDOC "1" "February 2010" "texdoc 0.65" "User Commands" .SH NAME texdoc \- find & view documentation in TeX Live .SH SYNOPSIS diff --git a/Master/texmf/doc/man/man1/texdoc.man1.pdf b/Master/texmf/doc/man/man1/texdoc.man1.pdf index 6ae1c6d9c35..072a6efaf1d 100644 Binary files a/Master/texmf/doc/man/man1/texdoc.man1.pdf and b/Master/texmf/doc/man/man1/texdoc.man1.pdf differ diff --git a/Master/texmf/doc/texdoc/News b/Master/texmf/doc/texdoc/News index e40ac7dbf31..4111da6b1ca 100644 --- a/Master/texmf/doc/texdoc/News +++ b/Master/texmf/doc/texdoc/News @@ -1,3 +1,9 @@ +Version 0.65 +------------ + +Make it easier to change the list of configuration files used (eg for +downstream distributions). + Version 0.64 ------------ diff --git a/Master/texmf/doc/texdoc/texdoc.pdf b/Master/texmf/doc/texdoc/texdoc.pdf index 59f4e68c18a..0fa9b3c942e 100644 Binary files a/Master/texmf/doc/texdoc/texdoc.pdf and b/Master/texmf/doc/texdoc/texdoc.pdf differ diff --git a/Master/texmf/doc/texdoc/texdoc.tex b/Master/texmf/doc/texdoc/texdoc.tex index bc6b474a01a..7cc3748fe7c 100644 --- a/Master/texmf/doc/texdoc/texdoc.tex +++ b/Master/texmf/doc/texdoc/texdoc.tex @@ -1,5 +1,5 @@ % this is texdoc's user manual -% written by Manuel Pégourié-Gonnard in 2008, 2009 +% written by Manuel Pégourié-Gonnard in 2008, 2010 % distributed under the terms of GPL v3 or later %!TEX encoding=latin1 @@ -219,8 +219,8 @@ option. For this, see the next section. \subsection{Configuration files}\label{ss-quick-file} \texdoc use various configuration files, which you can see using the ©-f© or -©--files© options. The second entry in this list is marked with a star ©(*)©: -it is the file you should use for your personal preferences as a user; you may +©--files© options. The entry marked with a star ©(*)© +is the file you should use for your personal preferences as a user; you may need to create it (and the parents directories). In order to select you favorite mode, just insert a line ©mode = «yourmode»© @@ -428,28 +428,22 @@ in the following order, where first value found is always used: \item Command-line options. \item Environment variables ending with ©_texdoc©. \item Other environment variables. - \item Values from configuration files, read in the following order: - \begin{enumerate} - \item ©TEXMFHOME/texdoc/texdoc-«platform».cnf© - \item ©TEXMFHOME/texdoc/texdoc.cnf© - \item ©TEXMFHOME/texdoc/texdoc-dist.cnf© - \item ©TEXMFLOCAL/texdoc/texdoc-«platform».cnf© - \item ©TEXMFLOCAL/texdoc/texdoc.cnf© - \item ©TEXMFMAIN/texdoc/texdoc.cnf© - \end{enumerate} + \item Values from configuration files, read in the same order as they are + printed by ©texdoc --files©. \item Hard-coded defaults that may depend on the current platform or the current value of another setting. \end{enumerate} -For the configuration files, ©«platform»© stands for the name of the current -platform, with names matching those of the directories in ©TEXLIVEROOT/bin©, -and ©TEXMFHOME© and others are the kpse's values, see the kpathsea and web2c -manuals. The name with ©«platform»© can be used on installation shared between -many machines where, for example, not the same viewers are available. However, -their use is not recommended in other situations. Finally, the special file -©texdoc-dist.cnf© allows you to install a newer version of \texdoc (including -its default config file) in your home: see \href{http://tug.org/texdoc/}{the - web page} for instructions on running \texdoc from the SVN. +The list of configuration files may include entries which depend on the +current platform, like ©texdoc-x86-64-linux.cnf© for instance. Those files are +meant to be used in when a single \texlive installation is shared across +machines with different architectures needing different settings. Their use is +not recommended in any other situation. + +Finally, the special file ©texdoc-dist.cnf© allows you to install a newer +version of \texdoc (including its default configuration file) in your home: +see \href{http://tug.org/texdoc/dev/}{the web page} for instructions on +running the development version. \subsection{Command-line options}\label{ss-cl} diff --git a/Master/texmf/scripts/texdoc/config.tlu b/Master/texmf/scripts/texdoc/config.tlu index 5ddc77e59bc..edcc59cab2a 100644 --- a/Master/texmf/scripts/texdoc/config.tlu +++ b/Master/texmf/scripts/texdoc/config.tlu @@ -281,8 +281,7 @@ function confline_to_config(line, file, pos) return false end - --- return a table with config file and if they exist +-- return the list of configuration files and the index of the recommended file function get_config_files () local platform = string.match (kpse.var_value ('SELFAUTOLOC'), '.*/(.*)$') local TEXMFHOME = kpse.var_value ('TEXMFHOME') @@ -294,8 +293,8 @@ function get_config_files () TEXMFHOME .. '/texdoc/texdoc-dist.cnf', TEXMFLOCAL .. '/texdoc/texdoc-'..platform..'.cnf', TEXMFLOCAL .. '/texdoc/texdoc.cnf', - TEXMFMAIN .. '/texdoc/texdoc.cnf' - } + TEXMFMAIN .. '/texdoc/texdoc.cnf', + }, 2 end -- the config_files table is shared by the next two functions @@ -304,14 +303,17 @@ local config_files = {} -- set config/aliases from all config files function setup_config_from_files () - for i, file in ipairs (get_config_files ()) do + local file_list, good_index = get_config_files() + for i, file in ipairs (file_list) do local found = lfs.isfile(file) + local status = found and (config.lastfile_switch + and 'disabled' or 'active') or 'absent' config_files[i] = { path = file, - status = found and (config.lastfile_switch - and 'disabled' or 'active') or 'absent', + status = status, + good = (i == good_index), } - if config_files[i].status == 'active' then + if status == 'active' then read_config_file (file) end end @@ -321,9 +323,9 @@ end function show_config_files (print_fun, prefix) print_fun("Configuration files are:") for i, file in ipairs (config_files) do - local home = prefix and - ((i==2) and "(*) " or " ") -- home conffile is the 2nd - or '' + local home = prefix + and (file.good and "(*) " or " ") + or '' print_fun (home..file.status..'\t'..win32_hook(file.path)) end if prefix then diff --git a/Master/texmf/scripts/texdoc/constants.tlu b/Master/texmf/scripts/texdoc/constants.tlu index 24163ea556b..a23d28ec6b0 100644 --- a/Master/texmf/scripts/texdoc/constants.tlu +++ b/Master/texmf/scripts/texdoc/constants.tlu @@ -15,7 +15,7 @@ load_env(L, { -- progname and version fullname = arg[0] progname = 'texdoc' -version = '0.64' +version = '0.65' -- make sure to update setup_config_from_cl() accordingly -- and set a default value in setup_config_from_defaults() if relevant diff --git a/Master/texmf/scripts/texdoc/score.tlu b/Master/texmf/scripts/texdoc/score.tlu index fee09a00014..6e74e86ca09 100644 --- a/Master/texmf/scripts/texdoc/score.tlu +++ b/Master/texmf/scripts/texdoc/score.tlu @@ -112,6 +112,7 @@ local suffixes = { '-guide', '-user', '-man', + 'notes', } -- compute a heuristic score 0 <= s < 10 diff --git a/Master/texmf/texdoc/texdoc.cnf b/Master/texmf/texdoc/texdoc.cnf index a849a0a0a1e..5c4fb44c8fb 100644 --- a/Master/texmf/texdoc/texdoc.cnf +++ b/Master/texmf/texdoc/texdoc.cnf @@ -2,17 +2,14 @@ # # DO NOT edit this file! # -# For your personal or local setting, use one of the following files: -# (the star points to the recommended file for a user's personal settings) -# TEXMFHOME/texdoc/texdoc-.cnf -# (*) TEXMFHOME/texdoc/texdoc.cnf -# TEXMFLOCAL/texdoc/texdoc-.cnf -# TEXMFLOCAL/texdoc/texdoc.cnf -# where stands for your architecture (eg, win32, i386-linux, -# powerpc-darwin). You can get this list with variables expanded by typing -# texdoc -f -# Those are read by texdoc in this order, and former values -# override later ones. +# For your personal or local setting, if you are a normal user, run 'texdoc -f' +# and use the file indicated by a star. You may need to create it. DO NOT copy +# the present file, please create a new one (you may want to copy/paste/edit +# portions of the present file, or just read it for inspiration). +# +# For system-wide confuguration or other uses, you may want to use the other +# files listed, see the manual (texdoc texdoc) for details. The files are read +# in the order they are printed. If a value is set multiple times, first wins. # # In those files, you can set your preferred viewer for various formats, # some nice names (alias) for specific documentation, and your preferred default @@ -30,8 +27,8 @@ # # %s is optional and stands for the filename. # -# viewer_pdf = xpdf # works -# viewer_pdf = xpdf %s & # works even better +# viewer_pdf = xpdf # works +# viewer_pdf = xpdf %s & # works even better # If you want to enable support for zipped documentation (see below), # you may want to adapt viewer_* so that it starts a subshell: @@ -70,10 +67,10 @@ # mode = view # interact_switch = true # alias_switch = true -# ext_list = pdf, html, txt, ps, dvi, # Note: empty string at end -# badext_list = txt, # Note: empty string at end -# verbosity_level = 2 # Print: 0 nothing, 1 errors, 2 warnings, 3: infos -# debug_list = # the empty list +# ext_list = pdf, html, txt, ps, dvi, # Note: empty string at end +# badext_list = txt, # Note: empty string at end +# verbosity_level = 2 # Print: 0 nothing, 1 errors, 2 warnings, 3: infos +# debug_list = # the empty list # machine_switch = false ### Score ### @@ -133,26 +130,26 @@ alias faq-en = newfaq alias faq = newfaq # various lshort translations (keep the obvious ones for the tests) -alias lshort = lshort-english/lshort # original -alias lshort-bg = lshort-bg # bulgarian -alias lshort-zh = lshort-zh-cn # chinese -alias lshort-nl = lshort-nl-1.3 # dutch -alias lshort-en = -english/lshort # english (original) -alias lshort-fi = lyhyt2e # finnish -alias lshort-fr = lshort-fr # french -alias lshort-de = l2kurz # german -alias lshort-it = itlshort # italian -alias lshort-ja = jlshort # japanese -alias lshort-pl = polish/lshort2e # polish -alias lshort-pt = ptlshort # portuguese -alias lshort-ru = lshortru # russian -alias lshort-sk = slshorte # slovak -alias lshort-sl = lshort-slovenian # slovenian -alias lshort-es = -spanish/lshort # spanish -alias lshort-th = lsh132 # thai -alias lshort-tr = lshort-tr # turkish -alias lshort-uk = lshort-ukr # ukrainian (package ukr, booh) -alias lshort-vi = lshort-vi # vietnamese +alias lshort = lshort-english/lshort # original +alias lshort-bg = lshort-bg # bulgarian +alias lshort-zh = lshort-zh-cn # chinese +alias lshort-nl = lshort-nl-1.3 # dutch +alias lshort-en = -english/lshort # english (original) +alias lshort-fi = lyhyt2e # finnish +alias lshort-fr = lshort-fr # french +alias lshort-de = l2kurz # german +alias lshort-it = itlshort # italian +alias lshort-ja = jlshort # japanese +alias lshort-pl = polish/lshort2e # polish +alias lshort-pt = ptlshort # portuguese +alias lshort-ru = lshortru # russian +alias lshort-sk = slshorte # slovak +alias lshort-sl = lshort-slovenian # slovenian +alias lshort-es = -spanish/lshort # spanish +alias lshort-th = lsh132 # thai +alias lshort-tr = lshort-tr # turkish +alias lshort-uk = lshort-ukr # ukrainian (package ukr, booh) +alias lshort-vi = lshort-vi # vietnamese # *TeX engines reference manuals, man pages and related @@ -339,7 +336,6 @@ alias index = ind alias genfont1 = fntguide alias psnfss = psnfss2e alias astro = astrosym.txt -alias braille = braille/summary alias brushscr = brushscr/AAA_readme alias ocherokee = cherokee alias cmsuper = cm-super/README @@ -493,10 +489,11 @@ alias vrbexin = vrbexin.sty alias vruler = vruler.sty alias wrapfig = wrapfig.sty -# the next line has no effect when this file is installed as -# TEXMFMAIN/texdoc/texdoc.cnf but is useful when it is installed as -# TEXMFHOME/texdoc/texdoc-dist.cnf for the purpose of installing a newer -# version of texdoc in one's home (eg, running the development version) +# The next line has no effect when this file is installed as the last +# configuration file (default) but is useful when you install it as the "tricky" +# configuration file (usually TEXMFHOME/texdoc/texdoc-dist.cnf) whose mere +# existence is a hack to make it easier to run the the development version, see +# . +# +# It is strongly recommended NOT to use it in any other circumstance. lastfile_switch = true - -# vim: ts=8 noexpandtab: -- cgit v1.2.3