source/texk/kpathsea/man/kpsewhich.man

   1 .TH KPSEWHICH 1 "1 March 2011" "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 Set debugging flags.
  47 .TP
  48 .BI -D \ num
  49 Use a base resolution of
  50 .IR num ;
  51 the default, set by the installer, is typically 600.
  52 .TP
  53 .BI -dpi \ num
  54 As
  55 .BR -D.
  56 .TP
  57 .BI -engine \ string
  58 Set
  59 .I $engine
  60 in the environment, which is used in some search paths.
  61 .TP
  62 .BI -expand-braces \ string
  63 Print variable and brace expansion of
  64 .IR string .
  65 .TP
  66 .BI -expand-path \ string
  67 Print complete path expansion of
  68 .IR string .
  69 .TP
  70 .BI -expand-var \ string
  71 Print variable expansion of
  72 .IR string .
  73 .TP
  74 .BI -format \ name
  75 Use file type
  76 .IR name .
  77 See the info manual for a list of valid names, or use the
  78 .B -help
  79 option to print the list.
  80 .TP
  81 .B -help
  82 Print help message and exit.
  83 .TP
  84 .B -interactive
  85 Ask for additional filenames to look up.
  86 .TP
  87 .BI -mktex \ fmt
  88 enable
  89 .RI mktex fmt
  90 generation.
  91 .RI ( fmt =pk/mf/tex/tfm)
  92 .TP
  93 .BI -mode \ string
  94 Set device name for
  95 .I $MAKETEX_MODE
  96 to
  97 .IR string ;
  98 no default.
  99 .TP
 100 .B -must-exist
 101 Search the disk as well as ls-R if necessary.
 102 .TP
 103 .BI -no-mktex \ fmt
 104 disable
 105 .RI mktex fmt
 106 generation.
 107 .RI ( fmt =pk/mf/tex/tfm)
 108 .TP
 109 .BI -path \ string
 110 Search in the path
 111 .IR string .
 112 .TP
 113 .BI -progname \ string
 114 Set program name to
 115 .IR string .
 116 .\" .TP
 117 .\" .BI -separator \ string
 118 .\" .rb
 119 .\" .I string
 120 .\" separates components in
 121 .\" .B -path
 122 .\" output; default is
 123 .\" .I :
 124 .\" on UNIX systems.
 125 .TP
 126 .BI -show-path \ name
 127 Output search path for file type
 128 .IR name .
 129 See the info manual for a list of valid names, or use the
 130 .B -help
 131 option to print the list.
 132 .TP
 133 .BI -var-value \ variable
 134 Print the expansion of
 135 .IR variable .
 136 .TP
 137 .B -version
 138 Print version information and exit.
 139 .\"=====================================================================
 140 .SH "SEE ALSO"
 141 .BR mktexlsr (1),
 142 .BR mktexmf (1),
 143 .BR mktexpk (1),
 144 .BR mktextfm (1).