1 % This is chkconfig.ltx, a script which tries to autodetect and
2 % document your LaTeX configuration.
3 % Author: Jean-Marc Lasgouttes (Jean-Marc.Lasgouttes@inria.fr)
4 % with minimal changes by Asger Alstrup (alstrup@diku.dk).
6 % This script should only be run from the configure script to update
7 % the files textclass.lst and doc/LaTeXConfig.lyx
9 % This script is in fact a complete rewrite of the original chkconfig
10 % script. Expect bugs.
12 %%% If you want to add new packages/documentclasses to be recognized,
13 %%% read the explanation that follow and jump to the section 'Actual
14 %%% inspection code' below. You do not need to understand the ugly
15 %%% LaTeX code below to help improving chkconfig.ltx :-)
17 %%% If you want to add the new package <name>, all you need most of
18 %%% the times is a two-steps work:
19 %%% 1- Add the command \TestPackage{<name>}. The syntax is:
20 %%% \TestPackage[<file>]{<name>}, which tests whether <name>.sty
21 %%% (or <file>, if this optional parameter is provided) exists.
22 %%% 2- Add a description for <name> in doc/LaTeXConfig.lyx.in,
23 %%% containing in particular a line like
24 %%% Found @chk_<name>@
25 %%% This line will be replaced at configure time by the proper text.
27 %%% For document classes, things are even simpler, since you do not
28 %%% need to edit this file. Just put your layout file in some place
29 %%% where LyX can find it and add if you wish a description in
30 %%% LaTeXConfig.lyx.in, as described above.
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33 %%%%%%%%%%%%%%%%%%%%%%% Initialization part (skip) %%%%%%%%%%%%%%%%%%%%%
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
36 % we do not want to stop on errors
37 \nonstopmode\makeatletter
39 %%% Some useful macros.
40 % Several commands are defined to test for packages:
41 % \AddLayout{<layout>} adds an entry for <layout> in textclass.lst
42 % \AddVariable{<name>}{<value>} creates a new variable chk_<name>,
43 % and gives it the value <value>.
44 % \TestDocClass{<name>}{<command>} if layout <name> has not already
45 % been tested for, execute <command>. Note that you will
46 % probably not need to use this directly, since the configure
47 % script generates the needed macro calls automatically.
48 % \TestPackage[<file>]{<name>} tests whether <name>.sty (or <file>,
49 % if it is provided) exists.
50 % Both commands call \AddVariable to give value 'yes' or 'no' to
51 % the variable chk_<name>.
53 \newcommand{\prefix}{+} % the character used by grep to filter 'good' output
54 \newcommand{\AddLayout}[4][\default]{
56 \immediate\write\layouts{"#2" "#1" "#3" "#4"}}
57 \newcommand{\AddVariable}[2]{
58 \immediate\write\sed{s!@chk_#1@!#2!g}
59 \immediate\write\vars{chk_#1='#2'}}
60 \newcommand{\AddPackage}[1]{
61 \immediate\write\packages{#1}}
62 % Tests whether an item is present
63 % Syntax: \TestItem{<file>}{<name>}{<type>}{<ext>}{<iftrue>}{<iffalse>}
65 \newcommand{\TestItem}[6][\default]{
68 \message{^^J\prefix checking for #3 #2 [#1]...}
69 \let\firstelement\relax
71 \@for\file:=\files\do{
72 \ifx\firstelement\relax
73 \edef\firstelement{\file}
77 {\IfFileExists{\file.#4}{}{\existsfalse}}
88 \newcommand{\TestPackage}[2][\default]{
89 \TestItem[#1]{#2}{package}{sty}{\AddPackage{#2}}{}}
90 \newcommand{\TestDocClass}[2]{
91 \def\layoutname{#1} % remember the name of the layout file
92 \@ifundefined{layout@#1}
93 {#2 % execute the command
94 \global\@namedef{layout@#1}{}}
95 {} % we have already tried this one.
97 \newcommand{\DeclareLaTeXClass}[2][\default]{
98 \TestItem[#1]{\layoutname}{document class}{cls}
99 {\AddLayout[\firstelement]{\layoutname}{#2}{true}}
100 {\AddLayout[\firstelement]{\layoutname}{#2}{false}}
102 % Only for compatibility. Will be removed later.
103 \let\DeclareSGMLClass=\DeclareDocBookClass
105 \newcommand{\DeclareDocBookClass}[2][\default]{
106 \message{^^J\prefix checking for docbook\space\space class \layoutname... }
107 \@ifundefined{hasdocbook}
109 \AddLayout[#1]{\layoutname}{#2}{false}}
111 \AddLayout[#1]{\layoutname}{#2}{true}}
114 % Stolen from article.cls
115 \newcommand{\today}{\ifcase\month\or
116 January\or February\or March\or April\or May\or June\or
117 July\or August\or September\or October\or November\or December\fi
118 \space\number\day, \number\year}
120 % Initializes the files
121 \typeout{\prefix Inspecting your LaTeX configuration.}
122 \newwrite{\layouts} \immediate\openout \layouts = textclass.lst
123 \newwrite{\sed} \immediate\openout \sed = chkconfig.sed
124 \newwrite{\vars} \immediate\openout \vars = chkconfig.vars
125 \newwrite{\packages} \immediate\openout \packages = packages.lst
127 \immediate\write\layouts{%
128 # This file declares layouts and their associated definition files.^^J%
129 # It has been automatically generated by configure^^J%
130 # Use "Options/Reconfigure" if you need to update it after a^^J%
131 # configuration change. Run ./configure manually to update the^^J%
132 # system wide version of this file.}
134 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
135 %%%%% ACTUAL CONFIGURATION INSPECTION CODE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
136 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
138 %%% Add any new package or document class here.
140 %%% First, we want the day on which the test has been run.
141 \AddVariable{date}{\today}
143 %%% Then, the version of LaTeX we are using
144 \message{^^J\prefix checking for LaTeX version... \fmtversion}
145 \AddVariable{fmtversion}{\fmtversion}
147 %%% And now, the list of available languages
148 % The trick is to know that \the\everyjob contains something like
149 % \typeout{LaTeX2e <2001/06/01>}
150 % \typeout{Babel <v3.7h> and hyphenation patterns for american, french, german, ngerman, nohyphenation, loaded.}
151 % All we have to do is to extract the list from there:
152 % (1) concatenate all the messages that are displayed everytime the
153 % format is loaded. The is done by redefining locally \typeout to
154 % append its argument to the macro \mesg.
156 {\def\typeout#1{\xdef\mesg{\mesg #1}}
158 % (2) strip the useless parts from \mesg. This uses the fact that TeX
159 % allows to define macros with parameters delimited by arbitrary text.
160 \def\strip#1patterns for #2, loaded.#3\endmark{\def\langs{#2}}
161 \expandafter\strip\mesg\endmark
162 % (3) handle the result
163 \message{^^J\prefix checking for available hyphenation patterns... \langs}
164 \AddVariable{languages}{\langs}
166 %%% Check for ec fonts. Most of this code has been shamelessely stolen
167 %%% from the file ltxcheck.tex in the LaTeX distribution. In particular,
168 %%% don't ask me how the macro \ecrm works...
174 {\expandafter\string\csname ecrm\endcsname}%
175 {\expandafter\expandafter\expandafter
176 \string\csname T1/cmr/m/n\endcsname}}%
180 \message{^^J\prefix checking for default encoding (this may take a long time)^^J}
181 \font\test=ecrm1000\relax
183 \message{^^J\prefix\prefix checking for ec fonts... no^^J}
185 \AddVariable{fontenc}{default}
187 \message{^^J\prefix\space\space checking for ec fonts... yes^^J}
188 \message{^^J\prefix\space\space checking for ec support in LaTeX format...}
192 \AddVariable{ec}{yes}
193 \AddVariable{fontenc}{T1}
194 \message{^^J \prefix\space\space default encoding will be set to T1^^J}
198 \AddVariable{fontenc}{default}
204 % The list of layout files has been put in this file here by the
210 \TestPackage{algorithm}
213 \TestPackage{bibtopic}
214 \TestPackage{booktabs}
215 \TestPackage{color} % this one should be there if graphics.sty is there.
216 \TestPackage{dvipost}
218 \TestPackage{fancybox}
219 \TestPackage{fancyhdr}
220 \TestPackage{floatflt}
222 \TestPackage{geometry}
223 \TestPackage{jurabib}
225 \TestPackage{longtable}
227 \TestPackage{nomencl}
228 \TestPackage{prettyref}
229 \TestPackage{preview}
230 \TestPackage{rotating}
231 \TestPackage{setspace}
232 \TestPackage{subfigure}
233 \TestPackage{textcomp}
234 \TestPackage{varioref}
237 % The test for the graphics package is slightly more involved...
238 \newcommand\groption{dvips}
239 \TestItem{graphicx}{package}{sty}
240 % Let's do some clever things to guess the default driver for the
241 % graphicx package. The maintainer of the site might have declared it
242 % in the file 'graphics.cfg'. Let's hope there are no strange commands
244 {\renewcommand\ExecuteOptions[1]{\renewcommand\groption{default}}
245 \InputIfFileExists{graphics.cfg}{}{}
246 \AddPackage{graphicx}}
247 {\renewcommand{\groption}{none}}
248 \message{^^J\prefix checking for graphics driver... \groption^^J}
249 \AddVariable{graphicsdriver}{\groption}
251 % psnfss is in fact the name of a set of style files, among which
252 % times.sty. If times.sty is here, we will assume that everything is
254 \TestPackage[times.sty]{psnfss}
255 % not sure if these are in all versions of psnfss
256 \TestPackage{mathptmx}
257 \TestPackage{mathptm}
258 \TestPackage{mathpazo}
259 \TestPackage{mathpple}
262 \TestPackage{bookman}
263 \TestPackage{newcent}
264 \TestPackage{charter}
265 \TestPackage{chancery}
266 % Other font packages
267 \TestPackage{lmodern}
269 \TestPackage{fourier}
270 \TestPackage{cmbright}
271 \TestPackage{luximono}
272 \TestPackage{ccfonts}
278 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
279 %%%%% END ACTUAL CONFIGURATION INSPECTION CODE %%%%%%%%%%%%%%%%%%%%%%%%%%%%
280 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
282 % End of the LaTeX job
283 \immediate\closeout\layouts
284 \immediate\closeout\sed
285 \immediate\closeout\vars
286 \immediate\closeout\packages
287 \typeout{\prefix Inspection done.}
288 \typeout{\prefix Read the file doc/LaTeXConfig.lyx for more information.}
289 % Get the real \end command, that has been hidden by LaTeX