tentative fix for issue 3 (ex 53)
[mplib] / src / texk / kpathsea / kpsewhich.man
1 .TH KPSEWHICH 1 "7 January 2007" "Kpathsea @VERSION@"
2 .\"=====================================================================
3 .if n .ds MP MetaPost
4 .if t .ds MP MetaPost
5 .if n .ds MF Metafont
6 .if t .ds MF M\s-2ETAFONT\s0
7 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
8 .if n .ds TX TeX
9 .ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff
10 .el .ds OX TeX for nroff
11 .\" the same but obliqued
12 .\" BX definition must follow TX so BX can use TX
13 .if t .ds BX \fRB\s-2IB\s0\fP\*(TX
14 .if n .ds BX BibTeX
15 .\" LX definition must follow TX so LX can use TX
16 .if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
17 .if n .ds LX LaTeX
18 .\"=====================================================================
19 .SH NAME
20 kpsewhich \- standalone path lookup and and expansion for kpathsea
21 .SH SYNOPSIS
22 .B kpsewhich
23 .RI [ options ]
24 .RI [ filenames ]
25 .\"=====================================================================
26 .SH DESCRIPTION
27 This manual page is not meant to be exhaustive.  The complete
28 documentation for this version of \*(TX can be found in the info file
29 or manual
30 .IR "Kpathsea: A library for path searching" .
31 .PP
32 .B kpsewhich
33 is used as a standalone front-end of the kpathsea library that can be
34 used to examine variables and find files.  When the
35 .B -format
36 option is not given, the search path used when looking for a file is
37 inferred from the name given, by looking for a known extension.  If
38 no known extension is found, the search path for \*(TX source files is
39 used.
40 .\"=====================================================================
41 .SH OPTIONS
42 .B kpsewhich
43 accepts the following options:
44 .TP
45 .BI -debug \ num
46 .rb
47 Set debugging flags.
48 .TP
49 .BI -D \ num
50 .rb
51 Use a base resolution of
52 .IR num ;
53 the default, set by the installer, is typically 600.
54 .TP
55 .BI -dpi \ num
56 As
57 .BR -D.
58 .TP
59 .BI -engine \ string
60 .rb
61 Set
62 .I $engine
63 in the environment, which is used in some search paths.
64 .TP
65 .BI -expand-braces \ string
66 .rb
67 Print variable and brace expansion of
68 .IR string .
69 .TP
70 .BI -expand-path \ string
71 .rb
72 Print complete path expansion of
73 .IR string .
74 .TP
75 .BI -expand-var \ string
76 .rb
77 Print variable expansion of
78 .IR string .
79 .TP
80 .BI -format \ name
81 .rb
82 Use file type
83 .IR name .
84 See the info manual for a list of valid names, or use the
85 .B -help
86 option to print the list.
87 .TP
88 .B -help
89 .rb
90 Print help message and exit.
91 .TP
92 .B -interactive
93 .rb
94 Ask for additional filenames to look up.
95 .TP
96 .BI -mktex \ fmt
97 .rb
98 enable
99 .RI mktex fmt
100 generation.
101 .RI ( fmt =pk/mf/tex/tfm)
102 .TP
103 .BI -mode \ string
104 .rb
105 Set device name for
106 .I $MAKETEX_MODE
107 to
108 .IR string ;
109 no default.
110 .TP
111 .B -must-exist
112 .rb
113 Search the disk as well as ls-R if necessary.
114 .TP
115 .BI -no-mktex \ fmt
116 .rb
117 disable
118 .RI mktex fmt
119 generation.
120 .RI ( fmt =pk/mf/tex/tfm)
121 .TP
122 .BI -path \ string
123 Search in the path
124 .IR string .
125 .TP
126 .BI -progname \ string
127 .rb
128 Set program name to
129 .IR string .
130 .\" .TP
131 .\" .BI -separator \ string
132 .\" .rb
133 .\" .I string
134 .\" separates components in
135 .\" .B -path
136 .\" output; default is
137 .\" .I :
138 .\" on UNIX systems.
139 .TP
140 .BI -show-path \ name
141 .rb
142 Output search path for file type
143 .IR name .
144 See the info manual for a list of valid names, or use the
145 .B -help
146 option to print the list.
147 .TP
148 .BI -var-value \ variable
149 .rb
150 Print the expansion of
151 .IR variable .
152 .TP
153 .B -version
154 .rb
155 Print version information and exit.
156 .\"=====================================================================
157 .SH "SEE ALSO"
158 .BR mktexlsr (1),
159 .BR mktexmf (1),
160 .BR mktexpk (1),
161 .BR mktextfm (1).