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/LyXConfig.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 chklatex.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/LyXConfig.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 %%% LyXConfig.lyx.in, as described above.
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33 %%%%%%%%%%%%%%%%%%%%%%% Initialization part (skip) %%%%%%%%%%%%%%%%%%%%%
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
36 % we do not want to stop on errors
37 \nonstopmode\makeatletter
38 % Have we been called from the configure script?
41 **** WARNING: For proper results, you should not run this script directly.^^J%
42 **** Please use the `configure' script.^^J}
43 \newcommand\srcdir{.}}
44 {\def\input@path{{\srcdir/}}}
46 %%% Some useful macros.
47 % Several commands are defined to test for packages:
48 % \AddLayout{<layout>} adds an entry for <layout> in textclass.lst
49 % \AddVariable{<name>}{<value>} creates a new variable chk_<name>,
50 % and gives it the value <value>.
51 % \TestDocClass[<file>]{<name>} tests whether <name>.cls (or <file>,
52 % if it is provided) exists and creates a new entry with
53 % \AddLayout if this is the case. Note that you will probably not
54 % need to use this directly, since the configure script generates
55 % the needed macro calls automatically.
56 % \TestPackage[<file>]{<name>} tests whether <name>.sty (or <file>,
57 % if it is provided) exists.
58 % Both commands call \AddVariable to give value 'yes' or 'no' to
59 % the variable chk_<name>.
61 \newcommand{\prefix}{+} % the character used by grep to filter 'good' output
62 \newcommand{\AddLayout}[3][\default]{
64 \immediate\write\layouts{"#2" "#1" "#3"}}
65 \newcommand{\AddVariable}[2]{
66 \immediate\write\sed{s!@chk_#1@!#2!g}
67 \immediate\write\vars{chk_#1='#2'}}
68 \newcommand{\AddPackage}[1]{
69 \immediate\write\packages{#1}}
70 % Tests whether an item is present
71 % Syntax: \TestItem{<file>}{<name>}{<type>}{<ext>}{<iftrue>}{<iffalse>}
73 \newcommand{\TestItem}[6][\default]{
76 \message{^^J\prefix checking for #3 #2 [#1]...}
77 \let\firstelement\relax
79 \@for\file:=\files\do{
80 \ifx\firstelement\relax
81 \edef\firstelement{\file}
85 {\IfFileExists{\file.#4}{}{\existsfalse}}
96 \newcommand{\TestPackage}[2][\default]{
97 \TestItem[#1]{#2}{package}{sty}{\AddPackage{#2}}{}}
98 \newcommand{\TestDocClass}[1]{
99 \def\layoutname{#1} % remember the name of the layout file
100 \@ifundefined{layout@#1}
102 \catcode`\#=9 % consider # as a space
103 \input{layouts/#1.layout} % read the layout file
105 \global\@namedef{layout@#1}{}}
106 {} % we have already tried this one.
108 \newcommand{\DeclareLaTeXClass}[2][\default]{
109 \TestItem[#1]{\layoutname}{document class}{cls}
110 {\AddLayout[\firstelement]{\layoutname}{#2}}{}
111 \expandafter\endinput
113 \newcommand{\DeclareLinuxDocClass}[2][\default]{
114 \message{^^J\prefix checking for linuxdoc class \layoutname... }
115 \@ifundefined{haslinuxdoc}
118 \AddLayout[#1]{\layoutname}{#2}}
119 \expandafter\endinput
121 % Only for compatibility. Will be removed later.
122 \let\DeclareSGMLClass=\DeclareDocBookClass
124 \newcommand{\DeclareDocBookClass}[2][\default]{
125 \message{^^J\prefix checking for docbook\space\space class \layoutname... }
126 \@ifundefined{hasdocbook}
129 \AddLayout[#1]{\layoutname}{#2}}
130 \expandafter\endinput
133 % Stolen from article.cls
134 \newcommand{\today}{\ifcase\month\or
135 January\or February\or March\or April\or May\or June\or
136 July\or August\or September\or October\or November\or December\fi
137 \space\number\day, \number\year}
139 % Initializes the files
140 \typeout{\prefix Inspecting your LaTeX configuration.}
141 \newwrite{\layouts} \immediate\openout \layouts = textclass.lst
142 \newwrite{\sed} \immediate\openout \sed = chkconfig.sed
143 \newwrite{\vars} \immediate\openout \vars = chkconfig.vars
144 \newwrite{\packages} \immediate\openout \packages = packages.lst
146 \immediate\write\layouts{%
147 # This file declares layouts and their associated definition files.^^J%
148 # It has been automatically generated by configure^^J%
149 # Use "Options/Reconfigure" if you need to update it after a^^J%
150 # configuration change. Run ./configure manually to update the^^J%
151 # system wide version of this file.}
153 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
154 %%%%% ACTUAL CONFIGURATION INSPECTION CODE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
155 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
157 %%% Add any new package or document class here.
159 %%% First, we want the day on which the test has been run.
160 \AddVariable{date}{\today}
162 %%% Then, the version of LaTeX we are using
163 \message{^^J\prefix checking for LaTeX version... \fmtversion}
164 \AddVariable{fmtversion}{\fmtversion}
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
214 \TestPackage{color} % this one should be there if graphics.sty is there.
215 \TestPackage{graphicx} % this one should be there if graphics.sty is there.
216 \TestPackage{fancyhdr}
217 \TestPackage{floatflt}
218 \TestPackage{setspace}
219 \TestPackage{subfigure}
220 \TestPackage{geometry}
221 \TestPackage{longtable}
222 \TestPackage{algorithm}
223 \TestPackage{rotating}
226 \TestPackage{varioref}
227 \TestPackage{prettyref}
230 % The test for the graphics package is slightly more involved...
231 \newcommand\groption{dvips}
232 \TestItem{graphics}{package}{sty}
233 % Let's do some clever things to guess the default driver for the
234 % graphics package. The maintainer of the site might have declared it
235 % in the file 'graphics.cfg'. Let's hope there are no strange commands
237 {\renewcommand\ExecuteOptions[1]{\renewcommand\groption{default}}
238 \InputIfFileExists{graphics.cfg}{}{}
239 \AddPackage{graphics}}
240 {\renewcommand{\groption}{none}}
241 \message{^^J\prefix checking for graphics driver... \groption^^J}
242 \AddVariable{graphicsdriver}{\groption}
244 % psnfss is in fact the name of a set of style files, among which
245 % times.sty. If times.sty is here, we will assume that everything is
247 \TestPackage[times.sty]{psnfss}
249 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
250 %%%%% END ACTUAL CONFIGURATION INSPECTION CODE %%%%%%%%%%%%%%%%%%%%%%%%%%%%
251 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
253 % End of the LaTeX job
254 \immediate\closeout\layouts
255 \immediate\closeout\sed
256 \immediate\closeout\vars
257 \immediate\closeout\packages
258 \typeout{\prefix Inspection done.}
259 \typeout{\prefix Read the file doc/LyXConfig.lyx for more information.}
260 % Get the real \end command, that has been hidden by LaTeX