comparison README.kpathsea @ 9031:1052a66078cf

Documentation cleanup of top-level Octave directory (READMEs, INSTALL) Spellcheck README and INSTALL files. Start all sentences with two spaces after period for readability.
author Rik <rdrider0-list@yahoo.com>
date Thu, 19 Mar 2009 20:47:36 -0700
parents 5eb3db6e4042
children 66fdc831c580
comparison
equal deleted inserted replaced
8984:cda45dc441f7 9031:1052a66078cf
58 In any case, you can *not* use the *names* below; you must always use 58 In any case, you can *not* use the *names* below; you must always use
59 somebody's numbers. (Sorry.) To set more than one option, just sum 59 somebody's numbers. (Sorry.) To set more than one option, just sum
60 the corresponding numbers. 60 the corresponding numbers.
61 61
62 `KPSE_DEBUG_STAT (1)' 62 `KPSE_DEBUG_STAT (1)'
63 Report `stat'(2) calls. This is useful for verifying that your 63 Report `stat'(2) calls. This is useful for verifying that your
64 directory structure is not forcing Kpathsea to do many additional 64 directory structure is not forcing Kpathsea to do many additional
65 file tests (*note Slow path searching::., and *note Subdirectory 65 file tests (*note Slow path searching::., and *note Subdirectory
66 expansion::.). If you are using an up-to-date `ls-R' database 66 expansion::.). If you are using an up-to-date `ls-R' database
67 (*note Filename database::.), this should produce no output unless 67 (*note Filename database::.), this should produce no output unless
68 a nonexistent file that must exist is searched for. 68 a nonexistent file that must exist is searched for.
69 69
70 `KPSE_DEBUG_HASH (2)' 70 `KPSE_DEBUG_HASH (2)'
71 Report lookups in all hash tables: `ls-R' and `aliases' (*note 71 Report lookups in all hash tables: `ls-R' and `aliases' (*note
73 file values (*note Config files::.). Useful when expected values 73 file values (*note Config files::.). Useful when expected values
74 are not being found, e.g.., file searches are looking at the disk 74 are not being found, e.g.., file searches are looking at the disk
75 instead of using `ls-R'. 75 instead of using `ls-R'.
76 76
77 `KPSE_DEBUG_FOPEN (4)' 77 `KPSE_DEBUG_FOPEN (4)'
78 Report file openings and closings. Especially useful when your 78 Report file openings and closings. Especially useful when your
79 system's file table is full, for seeing which files have been 79 system's file table is full, for seeing which files have been
80 opened but never closed. In case you want to set breakpoints in a 80 opened but never closed. In case you want to set breakpoints in a
81 debugger: this works by redefining `fopen' (`fclose') to be 81 debugger: this works by redefining `fopen' (`fclose') to be
82 `kpse_fopen_trace' (`kpse_fclose_trace'). 82 `kpse_fopen_trace' (`kpse_fclose_trace').
83 83
84 `KPSE_DEBUG_PATHS (8)' 84 `KPSE_DEBUG_PATHS (8)'
85 Report general path information for each file type Kpathsea is 85 Report general path information for each file type Kpathsea is
86 asked to search. This is useful when you are trying to track down 86 asked to search. This is useful when you are trying to track down
87 how a particular path got defined--from `texmf.cnf', `config.ps', 87 how a particular path got defined--from `texmf.cnf', `config.ps',
88 an environment variable, the compile-time default, etc. This is 88 an environment variable, the compile-time default, etc. This is
89 the contents of the `kpse_format_info_type' structure defined in 89 the contents of the `kpse_format_info_type' structure defined in
90 `tex-file.h'. 90 `tex-file.h'.
91 91
92 `KPSE_DEBUG_EXPAND (16)' 92 `KPSE_DEBUG_EXPAND (16)'
93 Report the directory list corresponding to each path element 93 Report the directory list corresponding to each path element
94 Kpathsea searches. This is only relevant when Kpathsea searches 94 Kpathsea searches. This is only relevant when Kpathsea searches
95 the disk, since `ls-R' searches don't look through directory lists 95 the disk, since `ls-R' searches don't look through directory lists
96 in this way. 96 in this way.
97 97
98 `KPSE_DEBUG_SEARCH (32)' 98 `KPSE_DEBUG_SEARCH (32)'
99 Report on each file search: the name of the file searched for, the 99 Report on each file search: the name of the file searched for, the
125 When the optional `mktex' programs are used, this will print 125 When the optional `mktex' programs are used, this will print
126 additional debugging info from functions internal to these 126 additional debugging info from functions internal to these
127 programs. 127 programs.
128 128
129 Debugging output from Kpathsea is always written to standard error, 129 Debugging output from Kpathsea is always written to standard error,
130 and begins with the string `kdebug:'. (Except for hash table buckets, 130 and begins with the string `kdebug:'. (Except for hash table buckets,
131 which just start with the number, but you can only get that output 131 which just start with the number, but you can only get that output
132 running under a debugger. See comments at the `hash_summary_only' 132 running under a debugger. See comments at the `hash_summary_only'
133 variable in `kpathsea/db.c'.) 133 variable in `kpathsea/db.c'.)
134 134
135 Logging 135 Logging
136 ------- 136 -------
137 137
143 `TEXMFLOG'. The value is the name of the file to append the 143 `TEXMFLOG'. The value is the name of the file to append the
144 information to. The file is created if it doesn't exist, and appended 144 information to. The file is created if it doesn't exist, and appended
145 to if it does. 145 to if it does.
146 146
147 Each successful search turns into one line in the log file: two words 147 Each successful search turns into one line in the log file: two words
148 separated by a space. The first word is the time of the search, as the 148 separated by a space. The first word is the time of the search, as the
149 integer number of seconds since "the epoch", i.e., UTC midnight 1 149 integer number of seconds since "the epoch", i.e., UTC midnight 1
150 January 1970 (more precisely, the result of the `time' system call). 150 January 1970 (more precisely, the result of the `time' system call).
151 The second word is the filename. 151 The second word is the filename.
152 152
153 For example, after `setenv TEXMFLOG /tmp/log', running Dvips on 153 For example, after `setenv TEXMFLOG /tmp/log', running Dvips on