home *** CD-ROM | disk | FTP | other *** search
/ Dream 57 / Amiga_Dream_57.iso / Amiga / Programmation / c / Docs / cxref-1.4a.lha / README.tex < prev    next >
LaTeX Document  |  1997-12-07  |  15.2 KB

open in: MacOS 8.1     |     Win98     |     DOS

browse contents    |     view JSON data     |     view as text


This file was processed as: LaTeX Document (document/latex).

ConfidenceProgramDetectionMatch TypeSupport
100% dexvert LaTeX Document (document/latex) magic Supported
1% dexvert Corel 10 Texture (image/corel10Texture) ext Unsupported
1% dexvert Croteam texture file (image/croteamTextureFile) ext Unsupported
1% dexvert Text File (text/txt) fallback Supported
100% file LaTeX document text default
99% file LaTeX document, ASCII text default
100% TrID LaTeX 2e document (with rem) default
100% checkBytes Printable ASCII default
100% perlTextCheck Likely Text (Perl) default
100% siegfried fmt/281 LaTeX (Subdocument) default
100% detectItEasy Format: plain text[LF] default (weak)
100% xdgMime text/x-matlab default (weak)



hex view
+--------+-------------------------+-------------------------+--------+--------+
|00000000| 25 20 54 68 69 73 20 4c | 61 54 65 58 20 66 69 6c |% This L|aTeX fil|
|00000010| 65 20 67 65 6e 65 72 61 | 74 65 64 20 62 79 20 63 |e genera|ted by c|
|00000020| 78 72 65 66 20 28 61 6e | 64 20 74 68 65 6e 20 65 |xref (an|d then e|
|00000030| 64 69 74 65 64 20 62 79 | 20 68 61 6e 64 29 2e 0a |dited by| hand)..|
|00000040| 25 20 63 78 72 65 66 20 | 70 72 6f 67 72 61 6d 20 |% cxref |program |
|00000050| 52 45 41 44 4d 45 20 28 | 63 29 20 41 6e 64 72 65 |README (|c) Andre|
|00000060| 77 20 4d 2e 20 42 69 73 | 68 6f 70 20 31 39 39 35 |w M. Bis|hop 1995|
|00000070| 2c 39 36 2c 39 37 2e 0a | 0a 5c 64 6f 63 75 6d 65 |,96,97..|.\docume|
|00000080| 6e 74 73 74 79 6c 65 5b | 64 6f 63 2f 66 6f 6e 74 |ntstyle[|doc/font|
|00000090| 73 2c 64 6f 63 2f 70 61 | 67 65 2c 64 6f 63 2f 63 |s,doc/pa|ge,doc/c|
|000000a0| 78 72 65 66 5d 7b 72 65 | 70 6f 72 74 7d 0a 5c 70 |xref]{re|port}.\p|
|000000b0| 61 67 65 73 74 79 6c 65 | 7b 6d 79 68 65 61 64 69 |agestyle|{myheadi|
|000000c0| 6e 67 73 7d 0a 0a 5c 62 | 65 67 69 6e 7b 64 6f 63 |ngs}..\b|egin{doc|
|000000d0| 75 6d 65 6e 74 7d 0a 0a | 25 20 43 6f 6e 74 65 6e |ument}..|% Conten|
|000000e0| 74 73 20 28 4f 70 74 69 | 6f 6e 61 6c 2c 20 65 69 |ts (Opti|onal, ei|
|000000f0| 74 68 65 72 20 68 65 72 | 65 20 6f 72 20 61 74 20 |ther her|e or at |
|00000100| 65 6e 64 29 0a 0a 25 5c | 6d 61 72 6b 62 6f 74 68 |end)..%\|markboth|
|00000110| 7b 43 6f 6e 74 65 6e 74 | 73 7d 7b 43 6f 6e 74 65 |{Content|s}{Conte|
|00000120| 6e 74 73 7d 0a 25 5c 74 | 61 62 6c 65 6f 66 63 6f |nts}.%\t|ableofco|
|00000130| 6e 74 65 6e 74 73 0a 0a | 5c 63 68 61 70 74 65 72 |ntents..|\chapter|
|00000140| 7b 43 20 43 72 6f 73 73 | 20 52 65 66 65 72 65 6e |{C Cross| Referen|
|00000150| 63 69 6e 67 20 5c 26 20 | 44 6f 63 75 6d 65 6e 74 |cing \& |Document|
|00000160| 69 6e 67 20 74 6f 6f 6c | 2e 20 56 65 72 73 69 6f |ing tool|. Versio|
|00000170| 6e 20 31 2e 34 61 20 2d | 20 63 78 72 65 66 7d 0a |n 1.4a -| cxref}.|
|00000180| 0a 41 20 70 72 6f 67 72 | 61 6d 20 74 68 61 74 20 |.A progr|am that |
|00000190| 63 61 6e 20 61 75 74 6f | 6d 61 74 69 63 61 6c 6c |can auto|maticall|
|000001a0| 79 20 67 65 6e 65 72 61 | 74 65 20 64 6f 63 75 6d |y genera|te docum|
|000001b0| 65 6e 74 61 74 69 6f 6e | 20 61 6e 64 20 63 72 6f |entation| and cro|
|000001c0| 73 73 20 72 65 66 65 72 | 65 6e 63 65 73 20 66 6f |ss refer|ences fo|
|000001d0| 72 0a 61 20 43 20 70 72 | 6f 67 72 61 6d 2e 0a 0a |r.a C pr|ogram...|
|000001e0| 54 68 65 20 69 6e 70 75 | 74 20 69 73 20 61 6e 79 |The inpu|t is any|
|000001f0| 20 43 20 70 72 6f 67 72 | 61 6d 20 77 69 74 68 20 | C progr|am with |
|00000200| 61 70 70 72 6f 70 72 69 | 61 74 65 20 63 6f 6d 6d |appropri|ate comm|
|00000210| 65 6e 74 73 20 61 6e 64 | 20 74 68 65 20 6f 75 74 |ents and| the out|
|00000220| 70 75 74 20 69 73 20 5c | 4c 61 54 65 58 20 6f 72 |put is \|LaTeX or|
|00000230| 0a 48 54 4d 4c 20 66 69 | 6c 65 73 2e 0a 0a 5c 73 |.HTML fi|les...\s|
|00000240| 65 63 74 69 6f 6e 7b 50 | 72 6f 67 72 61 6d 20 4f |ection{P|rogram O|
|00000250| 70 74 69 6f 6e 73 7d 0a | 0a 54 68 65 20 6e 61 6d |ptions}.|.The nam|
|00000260| 65 20 6f 66 20 74 68 65 | 20 70 72 6f 67 72 61 6d |e of the| program|
|00000270| 20 69 73 20 63 78 72 65 | 66 2e 0a 0a 5c 73 6d 61 | is cxre|f...\sma|
|00000280| 6c 6c 73 6b 69 70 0a 0a | 5c 62 65 67 69 6e 7b 74 |llskip..|\begin{t|
|00000290| 61 62 75 6c 61 72 7d 7b | 6c 6c 7d 0a 55 73 61 67 |abular}{|ll}.Usag|
|000002a0| 65 3a 20 7b 5c 74 74 20 | 63 78 72 65 66 7d 20 26 |e: {\tt |cxref} &|
|000002b0| 20 5c 5c 0a 26 20 7b 5c | 74 74 20 66 69 6c 65 6e | \\.& {\|tt filen|
|000002c0| 61 6d 65 20 5b 20 2e 2e | 2e 20 66 69 6c 65 6e 61 |ame [ ..|. filena|
|000002d0| 6d 65 5d 7d 20 5c 5c 0a | 26 20 7b 5c 74 74 20 5b |me]} \\.|& {\tt [|
|000002e0| 2d 4f 64 69 72 6e 61 6d | 65 5d 20 5b 2d 4e 62 61 |-Odirnam|e] [-Nba|
|000002f0| 73 65 6e 61 6d 65 5d 20 | 5b 2d 52 64 69 72 6e 61 |sename] |[-Rdirna|
|00000300| 6d 65 5d 7d 20 5c 5c 0a | 26 20 7b 5c 74 74 20 5b |me]} \\.|& {\tt [|
|00000310| 2d 61 6c 6c 2d 63 6f 6d | 6d 65 6e 74 73 5d 20 5b |-all-com|ments] [|
|00000320| 2d 6e 6f 2d 63 6f 6d 6d | 65 6e 74 73 5d 7d 20 5c |-no-comm|ents]} \|
|00000330| 5c 0a 26 20 7b 5c 74 74 | 20 5b 2d 76 65 72 62 61 |\.& {\tt| [-verba|
|00000340| 74 69 6d 2d 63 6f 6d 6d | 65 6e 74 73 5d 20 5b 2d |tim-comm|ents] [-|
|00000350| 62 6c 6f 63 6b 2d 63 6f | 6d 6d 65 6e 74 73 5d 7d |block-co|mments]}|
|00000360| 20 5c 5c 0a 26 20 7b 5c | 74 74 20 5b 2d 78 72 65 | \\.& {\|tt [-xre|
|00000370| 66 5b 2d 61 6c 6c 5d 5b | 2d 66 69 6c 65 5d 5b 2d |f[-all][|-file][-|
|00000380| 66 75 6e 63 5d 5b 2d 76 | 61 72 5d 5b 2d 74 79 70 |func][-v|ar][-typ|
|00000390| 65 5d 5d 7d 20 5c 5c 0a | 26 20 7b 5c 74 74 20 5b |e]]} \\.|& {\tt [|
|000003a0| 2d 77 61 72 6e 5b 2d 61 | 6c 6c 5d 5b 2d 63 6f 6d |-warn[-a|ll][-com|
|000003b0| 6d 65 6e 74 5d 5b 2d 78 | 72 65 66 5d 5d 7d 20 5c |ment][-x|ref]]} \|
|000003c0| 5c 0a 26 20 7b 5c 74 74 | 20 5b 2d 69 6e 64 65 78 |\.& {\tt| [-index|
|000003d0| 5b 2d 61 6c 6c 5d 5b 2d | 66 69 6c 65 5d 5b 2d 66 |[-all][-|file][-f|
|000003e0| 75 6e 63 5d 5b 2d 76 61 | 72 5d 5b 2d 74 79 70 65 |unc][-va|r][-type|
|000003f0| 5d 5d 7d 20 5c 5c 0a 26 | 20 7b 5c 74 74 20 5b 2d |]]} \\.&| {\tt [-|
|00000400| 72 61 77 5d 7d 20 5c 5c | 0a 26 20 7b 5c 74 74 20 |raw]} \\|.& {\tt |
|00000410| 5b 2d 6c 61 74 65 78 7c | 2d 6c 61 74 65 78 32 65 |[-latex||-latex2e|
|00000420| 5d 7d 20 5c 5c 0a 26 20 | 7b 5c 74 74 20 5b 2d 68 |]} \\.& |{\tt [-h|
|00000430| 74 6d 6c 5d 7d 20 5c 5c | 0a 26 20 7b 5c 74 74 20 |tml]} \\|.& {\tt |
|00000440| 5b 2d 49 64 69 72 6e 61 | 6d 65 5d 20 5b 2d 44 64 |[-Idirna|me] [-Dd|
|00000450| 65 66 69 6e 65 5d 20 5b | 2d 55 64 65 66 69 6e 65 |efine] [|-Udefine|
|00000460| 5d 7d 20 5c 5c 0a 26 20 | 7b 5c 74 74 20 5b 2d 43 |]} \\.& |{\tt [-C|
|00000470| 50 50 20 63 70 70 5c 5f | 70 72 6f 67 72 61 6d 5d |PP cpp\_|program]|
|00000480| 20 5b 2d 2d 20 63 70 70 | 5c 5f 61 72 67 20 5b 20 | [-- cpp|\_arg [ |
|00000490| 2e 2e 2e 20 63 70 70 5c | 5f 61 72 67 5d 5d 7d 20 |... cpp\|_arg]]} |
|000004a0| 5c 5c 0a 5c 65 6e 64 7b | 74 61 62 75 6c 61 72 7d |\\.\end{|tabular}|
|000004b0| 0a 5c 62 65 67 69 6e 7b | 74 61 62 75 6c 61 72 7d |.\begin{|tabular}|
|000004c0| 7b 6c 6c 7d 0a 55 73 61 | 67 65 3a 20 7b 5c 74 74 |{ll}.Usa|ge: {\tt|
|000004d0| 20 63 78 72 65 66 7d 20 | 26 20 5c 5c 0a 26 20 7b | cxref} |& \\.& {|
|000004e0| 5c 74 74 20 66 69 6c 65 | 6e 61 6d 65 20 5b 20 2e |\tt file|name [ .|
|000004f0| 2e 2e 20 66 69 6c 65 6e | 61 6d 65 5d 20 2d 64 65 |.. filen|ame] -de|
|00000500| 6c 65 74 65 7d 20 5c 5c | 0a 26 20 7b 5c 74 74 20 |lete} \\|.& {\tt |
|00000510| 5b 2d 4f 64 69 72 6e 61 | 6d 65 5d 20 5b 2d 4e 62 |[-Odirna|me] [-Nb|
|00000520| 61 73 65 6e 61 6d 65 5d | 20 5b 2d 52 64 69 72 6e |asename]| [-Rdirn|
|00000530| 61 6d 65 5d 7d 20 5c 5c | 0a 5c 65 6e 64 7b 74 61 |ame]} \\|.\end{ta|
|00000540| 62 75 6c 61 72 7d 0a 0a | 5c 62 65 67 69 6e 7b 6c |bular}..|\begin{l|
|00000550| 69 73 74 7d 7b 7d 7b 5c | 6c 65 66 74 6d 61 72 67 |ist}{}{\|leftmarg|
|00000560| 69 6e 3d 31 69 6e 20 5c | 6c 61 62 65 6c 77 69 64 |in=1in \|labelwid|
|00000570| 74 68 3d 32 2e 35 69 6e | 7d 0a 5c 69 74 65 6d 5b |th=2.5in|}.\item[|
|00000580| 7b 5c 74 74 20 66 69 6c | 65 6e 61 6d 65 7d 5d 0a |{\tt fil|ename}].|
|00000590| 54 68 65 20 6e 61 6d 65 | 20 6f 66 20 74 68 65 20 |The name| of the |
|000005a0| 66 69 6c 65 20 74 6f 20 | 64 6f 63 75 6d 65 6e 74 |file to |document|
|000005b0| 2c 20 61 6e 79 20 6e 75 | 6d 62 65 72 20 6f 66 20 |, any nu|mber of |
|000005c0| 66 69 6c 65 73 20 6d 61 | 79 20 62 65 0a 64 6f 63 |files ma|y be.doc|
|000005d0| 75 6d 65 6e 74 65 64 20 | 61 74 20 61 20 74 69 6d |umented |at a tim|
|000005e0| 65 2e 0a 5c 69 74 65 6d | 5b 7b 5c 74 74 20 2d 64 |e..\item|[{\tt -d|
|000005f0| 65 6c 65 74 65 7d 5d 0a | 54 68 65 20 66 69 6c 65 |elete}].|The file|
|00000600| 73 20 6e 61 6d 65 64 20 | 61 72 65 20 74 6f 20 62 |s named |are to b|
|00000610| 65 20 64 65 6c 65 74 65 | 64 20 66 72 6f 6d 20 74 |e delete|d from t|
|00000620| 68 65 20 6f 75 74 70 75 | 74 20 64 69 72 65 63 74 |he outpu|t direct|
|00000630| 6f 72 79 20 61 6e 64 0a | 74 68 65 69 72 20 65 6e |ory and.|their en|
|00000640| 74 72 69 65 73 20 69 6e | 20 74 68 65 20 63 72 6f |tries in| the cro|
|00000650| 73 73 20 72 65 66 65 72 | 65 6e 63 65 20 64 61 74 |ss refer|ence dat|
|00000660| 61 62 61 73 65 20 61 6e | 64 20 6d 61 69 6e 20 6f |abase an|d main o|
|00000670| 75 74 70 75 74 0a 66 69 | 6c 65 73 20 61 72 65 20 |utput.fi|les are |
|00000680| 74 6f 20 62 65 20 72 65 | 6d 6f 76 65 64 2e 0a 5c |to be re|moved..\|
|00000690| 69 74 65 6d 5b 7b 5c 74 | 74 20 2d 4f 64 69 72 6e |item[{\t|t -Odirn|
|000006a0| 61 6d 65 7d 5d 0a 54 68 | 65 20 6e 61 6d 65 20 6f |ame}].Th|e name o|
|000006b0| 66 20 61 20 64 69 72 65 | 63 74 6f 72 79 20 74 6f |f a dire|ctory to|
|000006c0| 20 75 73 65 20 66 6f 72 | 20 74 68 65 20 6f 75 74 | use for| the out|
|000006d0| 70 75 74 20 5c 4c 61 54 | 65 58 20 66 69 6c 65 73 |put \LaT|eX files|
|000006e0| 20 61 6e 64 0a 74 68 65 | 20 6c 6f 63 61 74 69 6f | and.the| locatio|
|000006f0| 6e 20 6f 66 20 74 68 65 | 20 63 72 6f 73 73 20 72 |n of the| cross r|
|00000700| 65 66 65 72 65 6e 63 65 | 20 66 69 6c 65 73 20 74 |eference| files t|
|00000710| 68 61 74 20 61 72 65 20 | 63 72 65 61 74 65 64 2e |hat are |created.|
|00000720| 0a 5c 69 74 65 6d 5b 7b | 5c 74 74 20 2d 4e 62 61 |.\item[{|\tt -Nba|
|00000730| 73 65 6e 61 6d 65 7d 5d | 0a 54 68 65 20 6e 61 6d |sename}]|.The nam|
|00000740| 65 20 74 6f 20 75 73 65 | 20 66 6f 72 20 74 68 65 |e to use| for the|
|00000750| 20 66 69 72 73 74 20 70 | 61 72 74 20 6f 66 20 74 | first p|art of t|
|00000760| 68 65 20 6f 75 74 70 75 | 74 20 61 6e 64 20 63 72 |he outpu|t and cr|
|00000770| 6f 73 73 0a 72 65 66 65 | 72 65 6e 63 65 20 66 69 |oss.refe|rence fi|
|00000780| 6c 65 73 20 69 6e 73 74 | 65 61 64 20 6f 66 20 63 |les inst|ead of c|
|00000790| 78 72 65 66 2c 20 74 68 | 65 20 66 69 6c 65 20 65 |xref, th|e file e|
|000007a0| 78 74 65 6e 73 69 6f 6e | 73 20 72 65 6d 61 69 6e |xtension|s remain|
|000007b0| 0a 74 68 65 20 73 61 6d | 65 2e 0a 5c 69 74 65 6d |.the sam|e..\item|
|000007c0| 5b 7b 5c 74 74 20 2d 52 | 64 69 72 6e 61 6d 65 7d |[{\tt -R|dirname}|
|000007d0| 5d 0a 57 68 65 6e 20 74 | 68 65 20 73 6f 75 72 63 |].When t|he sourc|
|000007e0| 65 20 66 69 6c 65 73 20 | 61 72 65 20 69 6e 20 6d |e files |are in m|
|000007f0| 6f 72 65 20 74 68 61 6e | 20 6f 6e 65 20 64 69 72 |ore than| one dir|
|00000800| 65 63 74 6f 72 79 2c 20 | 73 65 74 0a 64 69 72 6e |ectory, |set.dirn|
|00000810| 61 6d 65 20 74 6f 20 74 | 68 65 20 6e 61 6d 65 20 |ame to t|he name |
|00000820| 6f 66 20 74 68 65 20 72 | 6f 6f 74 20 64 69 72 65 |of the r|oot dire|
|00000830| 63 74 6f 72 79 20 6f 66 | 20 74 68 65 20 73 6f 75 |ctory of| the sou|
|00000840| 72 63 65 20 74 72 65 65 | 0a 28 75 73 65 20 72 65 |rce tree|.(use re|
|00000850| 6c 61 74 69 76 65 20 70 | 61 74 68 20 69 66 20 65 |lative p|ath if e|
|00000860| 61 73 69 65 72 20 65 2e | 67 2e 20 60 60 2d 52 2e |asier e.|g. ``-R.|
|00000870| 2e 2f 2e 2e 27 27 29 2e | 20 20 54 68 69 73 20 77 |./..'').| This w|
|00000880| 69 6c 6c 20 74 68 65 6e | 0a 72 75 6e 20 63 78 72 |ill then|.run cxr|
|00000890| 65 66 20 66 72 6f 6d 20 | 74 68 61 74 20 72 6f 6f |ef from |that roo|
|000008a0| 74 20 64 69 72 65 63 74 | 6f 72 79 20 61 6e 64 20 |t direct|ory and |
|000008b0| 74 68 65 20 60 60 2d 4f | 64 69 72 6e 61 6d 65 27 |the ``-O|dirname'|
|000008c0| 27 20 6d 75 73 74 20 62 | 65 0a 72 65 6c 61 74 69 |' must b|e.relati|
|000008d0| 76 65 20 74 6f 20 74 68 | 61 74 20 64 69 72 65 63 |ve to th|at direc|
|000008e0| 74 6f 72 79 2e 0a 5c 69 | 74 65 6d 5b 7b 5c 74 74 |tory..\i|tem[{\tt|
|000008f0| 20 2d 61 6c 6c 2d 63 6f | 6d 6d 65 6e 74 73 7d 5d | -all-co|mments}]|
|00000900| 0a 49 6e 20 63 61 73 65 | 20 79 6f 75 20 74 68 69 |.In case| you thi|
|00000910| 6e 6b 20 74 68 61 74 20 | 74 68 65 20 65 78 69 73 |nk that |the exis|
|00000920| 74 69 6e 67 20 63 6f 6d | 6d 65 6e 74 73 20 6d 69 |ting com|ments mi|
|00000930| 67 68 74 20 77 6f 72 6b | 2c 0a 28 73 65 65 20 62 |ght work|,.(see b|
|00000940| 65 6c 6f 77 20 66 6f 72 | 20 64 65 73 63 72 69 70 |elow for| descrip|
|00000950| 74 69 6f 6e 20 6f 66 20 | 73 70 65 63 69 61 6c 20 |tion of |special |
|00000960| 63 6f 6d 6d 65 6e 74 73 | 29 2e 0a 7b 5c 69 74 5b |comments|)..{\it[|
|00000970| 44 61 6e 67 65 72 21 20 | 54 68 69 73 20 6f 70 74 |Danger! |This opt|
|00000980| 69 6f 6e 20 63 61 6e 20 | 70 72 6f 64 75 63 65 20 |ion can |produce |
|00000990| 77 65 69 72 64 20 72 65 | 73 75 6c 74 73 2e 5d 7d |weird re|sults.]}|
|000009a0| 0a 5c 69 74 65 6d 5b 7b | 5c 74 74 20 2d 6e 6f 2d |.\item[{|\tt -no-|
|000009b0| 63 6f 6d 6d 65 6e 74 73 | 7d 5d 0a 49 67 6e 6f 72 |comments|}].Ignor|
|000009c0| 65 73 20 61 6c 6c 20 63 | 6f 6d 6d 65 6e 74 73 2c |es all c|omments,|
|000009d0| 20 75 73 65 66 75 6c 20 | 69 66 20 79 6f 75 20 6a | useful |if you j|
|000009e0| 75 73 74 20 77 61 6e 74 | 20 74 68 65 20 63 72 6f |ust want| the cro|
|000009f0| 73 73 0a 72 65 66 65 72 | 65 6e 63 65 73 20 61 6e |ss.refer|ences an|
|00000a00| 64 20 6e 6f 74 20 74 68 | 65 20 64 6f 63 75 6d 65 |d not th|e docume|
|00000a10| 6e 74 61 74 69 6f 6e 2e | 0a 5c 69 74 65 6d 5b 7b |ntation.|.\item[{|
|00000a20| 5c 74 74 20 2d 76 65 72 | 62 61 74 69 6d 2d 63 6f |\tt -ver|batim-co|
|00000a30| 6d 6d 65 6e 74 73 7d 5d | 0a 57 68 65 6e 20 74 68 |mments}]|.When th|
|00000a40| 65 20 63 6f 6d 6d 65 6e | 74 73 20 74 68 61 74 20 |e commen|ts that |
|00000a50| 79 6f 75 20 68 61 76 65 | 20 69 6e 20 74 68 65 20 |you have| in the |
|00000a60| 63 6f 64 65 20 61 72 65 | 20 66 6f 72 6d 61 74 74 |code are| formatt|
|00000a70| 65 64 0a 69 6e 20 61 20 | 70 72 65 64 65 74 65 72 |ed.in a |predeter|
|00000a80| 6d 69 6e 65 64 20 73 74 | 79 6c 65 20 74 68 61 74 |mined st|yle that|
|00000a90| 20 79 6f 75 20 77 61 6e | 74 20 74 6f 20 70 72 65 | you wan|t to pre|
|00000aa0| 73 65 72 76 65 20 6f 6e | 20 74 68 65 0a 6f 75 74 |serve on| the.out|
|00000ab0| 70 75 74 2c 20 74 68 69 | 73 20 6f 70 74 69 6f 6e |put, thi|s option|
|00000ac0| 20 77 69 6c 6c 20 66 6f | 72 63 65 20 74 68 65 6d | will fo|rce them|
|00000ad0| 20 6e 6f 74 20 74 6f 20 | 62 65 20 72 65 66 6f 72 | not to |be refor|
|00000ae0| 6d 61 74 74 65 64 2e 0a | 7b 5c 69 74 5b 4e 6f 74 |matted..|{\it[Not|
|00000af0| 65 2c 20 74 68 69 73 20 | 69 73 20 66 6f 72 20 66 |e, this |is for f|
|00000b00| 69 6c 65 20 61 6e 64 20 | 66 75 6e 63 74 69 6f 6e |ile and |function|
|00000b10| 20 63 6f 6d 6d 65 6e 74 | 73 20 6f 6e 6c 79 2e 5d | comment|s only.]|
|00000b20| 7d 0a 5c 69 74 65 6d 5b | 7b 5c 74 74 20 2d 62 6c |}.\item[|{\tt -bl|
|00000b30| 6f 63 6b 2d 63 6f 6d 6d | 65 6e 74 73 7d 5d 0a 57 |ock-comm|ents}].W|
|00000b40| 68 65 6e 20 74 68 65 20 | 63 6f 6d 6d 65 6e 74 73 |hen the |comments|
|00000b50| 20 69 6e 20 74 68 65 20 | 70 72 6f 67 72 61 6d 20 | in the |program |
|00000b60| 61 72 65 20 66 6f 72 6d | 61 74 74 65 64 20 69 6e |are form|atted in|
|00000b70| 20 74 68 65 20 60 60 62 | 6c 6f 63 6b 27 27 0a 73 | the ``b|lock''.s|
|00000b80| 74 79 6c 65 20 28 77 69 | 74 68 20 61 20 6c 65 61 |tyle (wi|th a lea|
|00000b90| 64 69 6e 67 20 60 60 2a | 27 27 20 63 68 61 72 61 |ding ``*|'' chara|
|00000ba0| 63 74 65 72 20 6f 6e 20 | 65 76 65 72 79 20 6c 69 |cter on |every li|
|00000bb0| 6e 65 29 2c 20 74 68 69 | 73 20 6f 70 74 69 6f 6e |ne), thi|s option|
|00000bc0| 0a 77 69 6c 6c 20 72 65 | 6d 6f 76 65 20 74 68 61 |.will re|move tha|
|00000bd0| 74 20 63 68 61 72 61 63 | 74 65 72 20 66 72 6f 6d |t charac|ter from|
|00000be0| 20 74 68 65 20 6f 75 74 | 70 75 74 2e 0a 7b 5c 69 | the out|put..{\i|
|00000bf0| 74 5b 57 6f 72 6b 73 20 | 66 6f 72 20 61 20 73 69 |t[Works |for a si|
|00000c00| 6e 67 6c 65 20 60 60 2a | 27 27 2c 20 60 60 2b 27 |ngle ``*|'', ``+'|
|00000c10| 27 2c 20 60 60 7c 27 27 | 20 6f 72 20 60 60 3a 27 |', ``|''| or ``:'|
|00000c20| 27 20 6f 6e 20 65 61 63 | 68 20 6c 69 6e 65 2e 5d |' on eac|h line.]|
|00000c30| 7d 0a 5c 69 74 65 6d 5b | 7b 5c 74 74 20 2d 78 72 |}.\item[|{\tt -xr|
|00000c40| 65 66 7d 5d 0a 50 72 6f | 64 75 63 65 20 63 72 6f |ef}].Pro|duce cro|
|00000c50| 73 73 20 72 65 66 65 72 | 65 6e 63 69 6e 67 20 69 |ss refer|encing i|
|00000c60| 6e 66 6f 72 6d 61 74 69 | 6f 6e 20 28 73 65 65 20 |nformati|on (see |
|00000c70| 62 65 6c 6f 77 29 2e 0a | 5c 62 65 67 69 6e 7b 6c |below)..|\begin{l|
|00000c80| 69 73 74 7d 7b 7d 7b 5c | 6c 65 66 74 6d 61 72 67 |ist}{}{\|leftmarg|
|00000c90| 69 6e 3d 31 69 6e 20 5c | 6c 61 62 65 6c 77 69 64 |in=1in \|labelwid|
|00000ca0| 74 68 3d 31 69 6e 7d 0a | 5c 69 74 65 6d 5b 7b 5c |th=1in}.|\item[{\|
|00000cb0| 74 74 20 2d 61 6c 6c 7d | 5d 20 20 20 20 41 6c 6c |tt -all}|] All|
|00000cc0| 20 63 72 6f 73 73 20 72 | 65 66 65 72 65 6e 63 65 | cross r|eference|
|00000cd0| 73 2e 0a 5c 69 74 65 6d | 5b 7b 5c 74 74 20 2d 66 |s..\item|[{\tt -f|
|00000ce0| 69 6c 65 7d 5d 20 20 20 | 43 72 6f 73 73 20 72 65 |ile}] |Cross re|
|00000cf0| 66 65 72 65 6e 63 65 73 | 20 66 6f 72 20 66 69 6c |ferences| for fil|
|00000d00| 65 73 2e 0a 5c 69 74 65 | 6d 5b 7b 5c 74 74 20 2d |es..\ite|m[{\tt -|
|00000d10| 66 75 6e 63 7d 5d 20 20 | 20 43 72 6f 73 73 20 72 |func}] | Cross r|
|00000d20| 65 66 65 72 65 6e 63 65 | 73 20 66 6f 72 20 66 75 |eference|s for fu|
|00000d30| 6e 63 74 69 6f 6e 73 2e | 0a 5c 69 74 65 6d 5b 7b |nctions.|.\item[{|
|00000d40| 5c 74 74 20 2d 76 61 72 | 7d 5d 20 20 20 20 43 72 |\tt -var|}] Cr|
|00000d50| 6f 73 73 20 72 65 66 65 | 72 65 6e 63 65 73 20 66 |oss refe|rences f|
|00000d60| 6f 72 20 76 61 72 69 61 | 62 6c 65 73 2e 0a 5c 69 |or varia|bles..\i|
|00000d70| 74 65 6d 5b 7b 5c 74 74 | 20 2d 74 79 70 65 7d 5d |tem[{\tt| -type}]|
|00000d80| 20 20 20 43 72 6f 73 73 | 20 72 65 66 65 72 65 6e | Cross| referen|
|00000d90| 63 65 73 20 66 6f 72 20 | 74 79 70 65 73 2e 0a 5c |ces for |types..\|
|00000da0| 65 6e 64 7b 6c 69 73 74 | 7d 0a 5c 69 74 65 6d 5b |end{list|}.\item[|
|00000db0| 7b 5c 74 74 20 2d 77 61 | 72 6e 7d 5d 0a 50 72 6f |{\tt -wa|rn}].Pro|
|00000dc0| 64 75 63 65 20 77 61 72 | 6e 69 6e 67 73 2c 20 74 |duce war|nings, t|
|00000dd0| 68 65 20 6f 70 74 69 6f | 6e 73 20 6d 75 73 74 20 |he optio|ns must |
|00000de0| 62 65 20 63 6f 6e 63 61 | 74 65 6e 61 74 65 64 20 |be conca|tenated |
|00000df0| 74 6f 67 65 74 68 65 72 | 3a 0a 5c 62 65 67 69 6e |together|:.\begin|
|00000e00| 7b 6c 69 73 74 7d 7b 7d | 7b 5c 6c 65 66 74 6d 61 |{list}{}|{\leftma|
|00000e10| 72 67 69 6e 3d 31 69 6e | 20 5c 6c 61 62 65 6c 77 |rgin=1in| \labelw|
|00000e20| 69 64 74 68 3d 31 69 6e | 7d 0a 5c 69 74 65 6d 5b |idth=1in|}.\item[|
|00000e30| 7b 5c 74 74 20 2d 61 6c | 6c 7d 5d 20 20 20 20 20 |{\tt -al|l}] |
|00000e40| 20 20 41 6c 6c 20 77 61 | 72 6e 69 6e 67 73 2e 0a | All wa|rnings..|
|00000e50| 5c 69 74 65 6d 5b 7b 5c | 74 74 20 2d 63 6f 6d 6d |\item[{\|tt -comm|
|00000e60| 65 6e 74 7d 5d 20 20 20 | 57 61 72 6e 20 6f 66 20 |ent}] |Warn of |
|00000e70| 6d 69 73 73 69 6e 67 20 | 63 6f 6d 6d 65 6e 74 73 |missing |comments|
|00000e80| 2e 0a 5c 69 74 65 6d 5b | 7b 5c 74 74 20 2d 78 72 |..\item[|{\tt -xr|
|00000e90| 65 66 7d 5d 20 20 20 20 | 20 20 57 61 72 6e 20 6f |ef}] | Warn o|
|00000ea0| 66 20 6d 69 73 73 69 6e | 67 20 63 72 6f 73 73 20 |f missin|g cross |
|00000eb0| 72 65 66 65 72 65 6e 63 | 65 73 2e 0a 5c 65 6e 64 |referenc|es..\end|
|00000ec0| 7b 6c 69 73 74 7d 0a 5c | 69 74 65 6d 5b 7b 5c 74 |{list}.\|item[{\t|
|00000ed0| 74 20 2d 69 6e 64 65 78 | 7d 5d 0a 50 72 6f 64 75 |t -index|}].Produ|
|00000ee0| 63 65 20 61 20 63 72 6f | 73 73 20 72 65 66 65 72 |ce a cro|ss refer|
|00000ef0| 65 6e 63 65 20 69 6e 64 | 65 78 2c 20 74 68 65 20 |ence ind|ex, the |
|00000f00| 6f 70 74 69 6f 6e 73 20 | 6d 75 73 74 20 62 65 0a |options |must be.|
|00000f10| 63 6f 6e 63 61 74 65 6e | 61 74 65 64 20 74 6f 67 |concaten|ated tog|
|00000f20| 65 74 68 65 72 3a 0a 5c | 62 65 67 69 6e 7b 6c 69 |ether:.\|begin{li|
|00000f30| 73 74 7d 7b 7d 7b 5c 6c | 65 66 74 6d 61 72 67 69 |st}{}{\l|eftmargi|
|00000f40| 6e 3d 31 69 6e 20 5c 6c | 61 62 65 6c 77 69 64 74 |n=1in \l|abelwidt|
|00000f50| 68 3d 31 69 6e 7d 0a 5c | 69 74 65 6d 5b 7b 5c 74 |h=1in}.\|item[{\t|
|00000f60| 74 20 2d 61 6c 6c 7d 5d | 20 20 20 20 41 6c 6c 20 |t -all}]| All |
|00000f70| 69 6e 64 65 78 65 73 2e | 0a 5c 69 74 65 6d 5b 7b |indexes.|.\item[{|
|00000f80| 5c 74 74 20 2d 66 69 6c | 65 7d 5d 20 20 20 49 6e |\tt -fil|e}] In|
|00000f90| 64 65 78 20 6f 66 20 66 | 69 6c 65 73 2e 0a 5c 69 |dex of f|iles..\i|
|00000fa0| 74 65 6d 5b 7b 5c 74 74 | 20 2d 66 75 6e 63 7d 5d |tem[{\tt| -func}]|
|00000fb0| 20 20 20 49 6e 64 65 78 | 20 6f 66 20 66 75 6e 63 | Index| of func|
|00000fc0| 74 69 6f 6e 73 2e 0a 5c | 69 74 65 6d 5b 7b 5c 74 |tions..\|item[{\t|
|00000fd0| 74 20 2d 76 61 72 7d 5d | 20 20 20 20 49 6e 64 65 |t -var}]| Inde|
|00000fe0| 78 20 6f 66 20 76 61 72 | 69 61 62 6c 65 73 2e 0a |x of var|iables..|
|00000ff0| 5c 69 74 65 6d 5b 7b 5c | 74 74 20 2d 74 79 70 65 |\item[{\|tt -type|
|00001000| 7d 5d 20 20 20 49 6e 64 | 65 78 20 6f 66 20 74 79 |}] Ind|ex of ty|
|00001010| 70 65 73 2e 0a 5c 65 6e | 64 7b 6c 69 73 74 7d 0a |pes..\en|d{list}.|
|00001020| 5c 69 74 65 6d 5b 7b 5c | 74 74 20 2d 72 61 77 7d |\item[{\|tt -raw}|
|00001030| 5d 0a 50 72 6f 64 75 63 | 65 20 61 20 72 61 77 20 |].Produc|e a raw |
|00001040| 66 6f 72 6d 20 6f 66 20 | 6f 75 74 70 75 74 2c 20 |form of |output, |
|00001050| 6e 6f 74 20 72 65 61 6c | 6c 79 20 6f 66 20 6d 75 |not real|ly of mu|
|00001060| 63 68 20 75 73 65 20 65 | 78 63 65 70 74 0a 77 69 |ch use e|xcept.wi|
|00001070| 74 68 20 2d 77 61 72 6e | 2e 0a 5c 69 74 65 6d 5b |th -warn|..\item[|
|00001080| 7b 5c 74 74 20 2d 6c 61 | 74 65 78 7d 5d 0a 50 72 |{\tt -la|tex}].Pr|
|00001090| 6f 64 75 63 65 20 61 20 | 5c 4c 61 54 65 58 20 66 |oduce a |\LaTeX f|
|000010a0| 69 6c 65 20 74 6f 20 64 | 6f 63 75 6d 65 6e 74 20 |ile to d|ocument |
|000010b0| 65 61 63 68 20 6f 66 20 | 74 68 65 20 73 6f 75 72 |each of |the sour|
|000010c0| 63 65 20 66 69 6c 65 73 | 20 61 6e 64 0a 61 6c 73 |ce files| and.als|
|000010d0| 6f 20 61 6e 20 65 78 74 | 72 61 20 66 69 6c 65 20 |o an ext|ra file |
|000010e0| 74 68 61 74 20 69 6e 63 | 6c 75 64 65 73 20 65 61 |that inc|ludes ea|
|000010f0| 63 68 20 6f 66 20 74 68 | 65 73 65 20 66 69 6c 65 |ch of th|ese file|
|00001100| 73 2e 0a 5c 69 74 65 6d | 5b 7b 5c 74 74 20 2d 6c |s..\item|[{\tt -l|
|00001110| 61 74 65 78 32 65 7d 5d | 0a 50 72 6f 64 75 63 65 |atex2e}]|.Produce|
|00001120| 20 74 68 65 20 5c 4c 61 | 54 65 58 20 66 69 6c 65 | the \La|TeX file|
|00001130| 20 64 65 73 63 72 69 62 | 65 64 20 61 62 6f 76 65 | describ|ed above|
|00001140| 20 66 6f 72 20 75 73 65 | 20 77 69 74 68 20 74 68 | for use| with th|
|00001150| 65 20 5c 4c 61 54 65 58 | 20 32 65 0a 76 65 72 73 |e \LaTeX| 2e.vers|
|00001160| 69 6f 6e 20 6f 66 20 5c | 4c 61 54 65 58 2e 0a 5c |ion of \|LaTeX..\|
|00001170| 69 74 65 6d 5b 7b 5c 74 | 74 20 2d 68 74 6d 6c 7d |item[{\t|t -html}|
|00001180| 5d 0a 50 72 6f 64 75 63 | 65 20 61 6e 20 48 54 4d |].Produc|e an HTM|
|00001190| 4c 20 66 69 6c 65 20 74 | 6f 20 64 6f 63 75 6d 65 |L file t|o docume|
|000011a0| 6e 74 20 65 61 63 68 20 | 6f 66 20 74 68 65 20 73 |nt each |of the s|
|000011b0| 6f 75 72 63 65 20 66 69 | 6c 65 73 20 61 6e 64 0a |ource fi|les and.|
|000011c0| 61 20 6d 61 69 6e 20 66 | 69 6c 65 20 74 6f 20 72 |a main f|ile to r|
|000011d0| 65 66 65 72 65 6e 63 65 | 20 65 61 63 68 20 6f 66 |eference| each of|
|000011e0| 20 74 68 65 73 65 20 66 | 69 6c 65 73 2e 0a 5c 69 | these f|iles..\i|
|000011f0| 74 65 6d 5b 7b 5c 74 74 | 20 2d 49 64 69 72 6e 61 |tem[{\tt| -Idirna|
|00001200| 6d 65 7d 5d 0a 47 43 43 | 20 6f 70 74 69 6f 6e 20 |me}].GCC| option |
|00001210| 74 6f 20 73 70 65 63 69 | 66 79 20 74 68 65 20 70 |to speci|fy the p|
|00001220| 61 74 68 20 66 6f 72 20 | 69 6e 63 6c 75 64 65 20 |ath for |include |
|00001230| 66 69 6c 65 73 2e 0a 5c | 69 74 65 6d 5b 7b 5c 74 |files..\|item[{\t|
|00001240| 74 20 2d 44 64 65 66 69 | 6e 65 7d 5d 0a 47 43 43 |t -Ddefi|ne}].GCC|
|00001250| 20 6f 70 74 69 6f 6e 20 | 74 6f 20 64 65 66 69 6e | option |to defin|
|00001260| 65 20 61 20 70 72 65 2d | 70 72 6f 63 65 73 73 6f |e a pre-|processo|
|00001270| 72 20 73 79 6d 62 6f 6c | 2e 0a 5c 69 74 65 6d 5b |r symbol|..\item[|
|00001280| 7b 5c 74 74 20 2d 55 64 | 65 66 69 6e 65 7d 5d 0a |{\tt -Ud|efine}].|
|00001290| 47 43 43 20 6f 70 74 69 | 6f 6e 20 74 6f 20 75 6e |GCC opti|on to un|
|000012a0| 64 65 66 69 6e 65 20 61 | 20 70 72 65 2d 70 72 6f |define a| pre-pro|
|000012b0| 63 65 73 73 6f 72 20 73 | 79 6d 62 6f 6c 2e 0a 5c |cessor s|ymbol..\|
|000012c0| 69 74 65 6d 5b 7b 5c 74 | 74 20 2d 43 50 50 20 70 |item[{\t|t -CPP p|
|000012d0| 72 6f 67 72 61 6d 7d 5d | 0a 54 68 65 20 6e 61 6d |rogram}]|.The nam|
|000012e0| 65 20 6f 66 20 74 68 65 | 20 70 72 6f 67 72 61 6d |e of the| program|
|000012f0| 20 74 6f 20 75 73 65 20 | 69 6e 73 74 65 61 64 20 | to use |instead |
|00001300| 6f 66 20 74 68 65 20 63 | 6f 6d 70 69 6c 65 20 74 |of the c|ompile t|
|00001310| 69 6d 65 0a 64 65 66 61 | 75 6c 74 2e 20 54 68 65 |ime.defa|ult. The|
|00001320| 20 70 72 6f 67 72 61 6d | 20 6d 75 73 74 20 62 65 | program| must be|
|00001330| 20 61 62 6c 65 20 74 6f | 20 70 65 72 66 6f 72 6d | able to| perform|
|00001340| 20 61 6c 6c 20 6f 66 20 | 74 68 65 20 61 63 74 69 | all of |the acti|
|00001350| 6f 6e 73 0a 74 68 61 74 | 20 60 60 67 63 63 20 2d |ons.that| ``gcc -|
|00001360| 45 20 2d 43 20 2d 64 44 | 27 27 20 64 6f 65 73 20 |E -C -dD|'' does |
|00001370| 74 6f 20 77 6f 72 6b 2e | 20 20 49 66 20 74 68 65 |to work.| If the|
|00001380| 20 70 72 6f 67 72 61 6d | 20 74 61 6b 65 73 0a 61 | program| takes.a|
|00001390| 72 67 75 6d 65 6e 74 73 | 20 74 68 65 6e 20 74 68 |rguments| then th|
|000013a0| 65 20 77 68 6f 6c 65 20 | 74 68 69 6e 67 20 6e 65 |e whole |thing ne|
|000013b0| 65 64 73 20 74 6f 20 62 | 65 20 69 6e 20 71 75 6f |eds to b|e in quo|
|000013c0| 74 65 73 20 73 6f 20 74 | 68 61 74 20 69 74 0a 69 |tes so t|hat it.i|
|000013d0| 73 20 69 6e 74 65 72 70 | 72 65 74 65 64 20 61 73 |s interp|reted as|
|000013e0| 20 61 20 73 69 6e 67 6c | 65 20 61 72 67 75 6d 65 | a singl|e argume|
|000013f0| 6e 74 20 74 6f 20 63 78 | 72 65 66 2e 0a 5c 69 74 |nt to cx|ref..\it|
|00001400| 65 6d 5b 7b 5c 74 74 2d | 2d 20 61 72 67 20 2e 2e |em[{\tt-|- arg ..|
|00001410| 2e 20 61 72 67 7d 5d 0a | 45 78 74 72 61 20 61 72 |. arg}].|Extra ar|
|00001420| 67 75 6d 65 6e 74 73 20 | 74 6f 20 62 65 20 70 61 |guments |to be pa|
|00001430| 73 73 65 64 20 74 6f 20 | 74 68 65 20 70 72 65 2d |ssed to |the pre-|
|00001440| 70 72 6f 63 65 73 73 6f | 72 20 63 61 6e 20 62 65 |processo|r can be|
|00001450| 20 70 6c 61 63 65 64 0a | 61 66 74 65 72 20 74 68 | placed.|after th|
|00001460| 65 20 60 60 2d 2d 27 27 | 20 73 65 70 61 72 61 74 |e ``--''| separat|
|00001470| 6f 72 2e 0a 5c 65 6e 64 | 7b 6c 69 73 74 7d 0a 0a |or..\end|{list}..|
|00001480| 5c 73 65 63 74 69 6f 6e | 7b 43 20 43 6f 6d 70 69 |\section|{C Compi|
|00001490| 6c 65 72 20 52 65 70 6c | 61 63 65 6d 65 6e 74 20 |ler Repl|acement |
|000014a0| 63 78 72 65 66 2d 63 63 | 7d 0a 0a 54 6f 20 73 69 |cxref-cc|}..To si|
|000014b0| 6d 70 6c 69 66 79 20 75 | 73 69 6e 67 20 63 78 72 |mplify u|sing cxr|
|000014c0| 65 66 20 6f 6e 20 65 78 | 69 73 74 69 6e 67 20 73 |ef on ex|isting s|
|000014d0| 6f 75 72 63 65 20 63 6f | 64 65 2c 20 74 68 65 72 |ource co|de, ther|
|000014e0| 65 20 69 73 20 6e 6f 77 | 20 61 20 73 68 65 6c 6c |e is now| a shell|
|000014f0| 20 73 63 72 69 70 74 0a | 74 68 61 74 20 77 69 6c | script.|that wil|
|00001500| 6c 20 63 61 6c 6c 20 74 | 68 65 20 43 20 63 6f 6d |l call t|he C com|
|00001510| 70 69 6c 65 72 20 61 6e | 64 20 74 68 65 6e 20 63 |piler an|d then c|
|00001520| 61 6c 6c 20 63 78 72 65 | 66 20 74 6f 20 70 72 6f |all cxre|f to pro|
|00001530| 63 65 73 73 20 74 68 65 | 20 73 6f 75 72 63 65 20 |cess the| source |
|00001540| 66 69 6c 65 2e 0a 54 68 | 69 73 20 6d 65 61 6e 73 |file..Th|is means|
|00001550| 20 74 68 61 74 20 69 74 | 20 63 61 6e 20 62 65 20 | that it| can be |
|00001560| 75 73 65 64 20 61 73 20 | 61 20 64 72 6f 70 20 69 |used as |a drop i|
|00001570| 6e 20 72 65 70 6c 61 63 | 65 6d 65 6e 74 20 66 6f |n replac|ement fo|
|00001580| 72 20 43 43 20 69 6e 20 | 4d 61 6b 65 66 69 6c 65 |r CC in |Makefile|
|00001590| 73 20 61 6e 64 0a 74 68 | 65 20 6c 69 6b 65 2e 0a |s and.th|e like..|
|000015a0| 0a 55 73 61 67 65 3a 20 | 63 78 72 65 66 2d 63 63 |.Usage: |cxref-cc|
|000015b0| 20 5b 75 73 75 61 6c 20 | 63 63 20 6f 70 74 69 6f | [usual |cc optio|
|000015c0| 6e 73 5d 0a 0a 54 68 65 | 20 6e 61 6d 65 20 6f 66 |ns]..The| name of|
|000015d0| 20 74 68 65 20 73 6f 75 | 72 63 65 20 66 69 6c 65 | the sou|rce file|
|000015e0| 20 69 73 20 65 78 74 72 | 61 63 74 65 64 20 66 72 | is extr|acted fr|
|000015f0| 6f 6d 20 74 68 65 20 6c | 69 73 74 20 6f 66 20 6f |om the l|ist of o|
|00001600| 70 74 69 6f 6e 73 20 61 | 73 20 77 65 6c 6c 20 61 |ptions a|s well a|
|00001610| 73 20 74 68 65 0a 60 60 | 2d 44 2a 27 27 2c 20 60 |s the.``|-D*'', `|
|00001620| 60 2d 49 2a 27 27 2c 20 | 60 60 2d 55 2a 27 27 20 |`-I*'', |``-U*'' |
|00001630| 66 6c 61 67 73 20 61 6e | 64 20 77 68 65 6e 20 74 |flags an|d when t|
|00001640| 68 65 20 43 20 63 6f 6d | 70 69 6c 65 72 20 65 78 |he C com|piler ex|
|00001650| 69 74 73 20 73 75 63 63 | 65 73 66 75 6c 6c 79 20 |its succ|esfully |
|00001660| 63 78 72 65 66 20 77 69 | 6c 6c 0a 62 65 20 63 61 |cxref wi|ll.be ca|
|00001670| 6c 6c 65 64 2e 20 20 54 | 68 65 20 6e 61 6d 65 20 |lled. T|he name |
|00001680| 6f 66 20 74 68 65 20 43 | 20 63 6f 6d 70 69 6c 65 |of the C| compile|
|00001690| 72 20 74 6f 20 75 73 65 | 20 69 73 20 63 6f 6e 74 |r to use| is cont|
|000016a0| 72 6f 6c 6c 65 64 20 62 | 79 20 74 68 65 20 43 58 |rolled b|y the CX|
|000016b0| 52 45 46 43 43 0a 65 6e | 76 69 72 6f 6e 6d 65 6e |REFCC.en|vironmen|
|000016c0| 74 20 76 61 72 69 61 62 | 6c 65 2c 20 6f 72 20 69 |t variab|le, or i|
|000016d0| 66 20 74 68 69 73 20 69 | 73 20 6e 6f 74 20 73 65 |f this i|s not se|
|000016e0| 74 20 74 68 65 6e 20 74 | 68 65 20 43 43 20 65 6e |t then t|he CC en|
|000016f0| 76 69 72 6f 6e 6d 65 6e | 74 20 76 61 72 69 61 62 |vironmen|t variab|
|00001700| 6c 65 2c 20 6f 72 0a 66 | 61 69 6c 69 6e 67 20 74 |le, or.f|ailing t|
|00001710| 68 69 73 20 6a 75 73 74 | 20 67 63 63 2e 0a 0a 55 |his just| gcc...U|
|00001720| 73 69 6e 67 20 74 68 69 | 73 20 73 63 72 69 70 74 |sing thi|s script|
|00001730| 20 72 65 71 75 69 72 65 | 73 20 74 68 65 20 75 73 | require|s the us|
|00001740| 65 20 6f 66 20 61 20 60 | 2e 63 78 72 65 66 27 20 |e of a `|.cxref' |
|00001750| 63 6f 6e 66 69 67 75 72 | 61 74 69 6f 6e 20 66 69 |configur|ation fi|
|00001760| 6c 65 20 74 6f 20 63 6f | 6e 74 61 69 6e 0a 74 68 |le to co|ntain.th|
|00001770| 65 20 6f 70 74 69 6f 6e | 73 20 73 69 6e 63 65 20 |e option|s since |
|00001780| 74 68 65 72 65 20 69 73 | 20 6e 6f 77 68 65 72 65 |there is| nowhere|
|00001790| 20 74 6f 20 70 75 74 20 | 74 68 65 20 6f 70 74 69 | to put |the opti|
|000017a0| 6f 6e 73 20 6f 6e 20 74 | 68 65 20 63 6f 6d 6d 61 |ons on t|he comma|
|000017b0| 6e 64 20 6c 69 6e 65 20 | 66 6f 72 0a 74 68 65 20 |nd line |for.the |
|000017c0| 43 20 63 6f 6d 70 69 6c | 65 72 2e 0a 0a 54 68 69 |C compil|er...Thi|
|000017d0| 73 20 77 69 6c 6c 20 6f | 6e 6c 79 20 63 72 6f 73 |s will o|nly cros|
|000017e0| 73 2d 72 65 66 65 72 65 | 6e 63 65 20 61 6e 64 20 |s-refere|nce and |
|000017f0| 64 6f 63 75 6d 65 6e 74 | 20 74 68 65 20 43 20 73 |document| the C s|
|00001800| 6f 75 72 63 65 20 66 69 | 6c 65 73 20 73 69 6e 63 |ource fi|les sinc|
|00001810| 65 20 74 68 65 79 20 61 | 72 65 0a 74 68 65 20 6f |e they a|re.the o|
|00001820| 6e 6c 79 20 6f 6e 65 73 | 20 74 68 61 74 20 61 72 |nly ones| that ar|
|00001830| 65 20 63 6f 6d 70 69 6c | 65 64 2c 20 62 75 74 20 |e compil|ed, but |
|00001840| 69 74 20 77 69 6c 6c 20 | 6d 61 6b 65 20 73 75 72 |it will |make sur|
|00001850| 65 20 74 68 61 74 20 74 | 68 65 79 20 61 72 65 0a |e that t|hey are.|
|00001860| 63 72 6f 73 73 2d 72 65 | 66 65 72 65 6e 63 65 64 |cross-re|ferenced|
|00001870| 20 77 69 74 68 20 74 68 | 65 20 63 6f 72 72 65 63 | with th|e correc|
|00001880| 74 20 6f 70 74 69 6f 6e | 73 20 65 74 63 2e 0a 0a |t option|s etc...|
|00001890| 5c 73 65 63 74 69 6f 6e | 7b 43 78 72 65 66 20 63 |\section|{Cxref c|
|000018a0| 6f 6e 66 69 67 75 72 61 | 74 69 6f 6e 20 46 69 6c |onfigura|tion Fil|
|000018b0| 65 7d 0a 0a 54 68 65 73 | 65 20 63 6f 6d 6d 61 6e |e}..Thes|e comman|
|000018c0| 64 20 6c 69 6e 65 20 61 | 72 67 75 6d 65 6e 74 73 |d line a|rguments|
|000018d0| 20 63 61 6e 20 61 6c 73 | 6f 20 62 65 20 70 75 74 | can als|o be put|
|000018e0| 20 69 6e 74 6f 20 61 20 | 66 69 6c 65 20 6e 61 6d | into a |file nam|
|000018f0| 65 64 20 60 60 2e 63 78 | 72 65 66 27 27 20 69 6e |ed ``.cx|ref'' in|
|00001900| 73 74 65 61 64 20 6f 66 | 0a 6f 6e 20 74 68 65 20 |stead of|.on the |
|00001910| 63 6f 6d 6d 61 6e 64 20 | 6c 69 6e 65 2e 20 20 57 |command |line. W|
|00001920| 68 65 6e 20 63 78 72 65 | 66 20 69 73 20 72 75 6e |hen cxre|f is run|
|00001930| 20 74 68 65 20 61 72 67 | 75 6d 65 6e 74 73 20 74 | the arg|uments t|
|00001940| 6f 20 74 68 65 20 70 72 | 6f 67 72 61 6d 20 61 72 |o the pr|ogram ar|
|00001950| 65 0a 69 6e 74 65 72 70 | 72 65 74 65 64 20 69 6e |e.interp|reted in|
|00001960| 20 74 68 65 20 66 6f 6c | 6c 6f 77 69 6e 67 20 6f | the fol|lowing o|
|00001970| 72 64 65 72 2e 0a 0a 5c | 62 65 67 69 6e 7b 65 6e |rder...\|begin{en|
|00001980| 75 6d 65 72 61 74 65 7d | 0a 5c 69 74 65 6d 20 54 |umerate}|.\item T|
|00001990| 68 6f 73 65 20 6f 6e 20 | 74 68 65 20 63 6f 6d 6d |hose on |the comm|
|000019a0| 61 6e 64 20 6c 69 6e 65 | 2e 0a 5c 69 74 65 6d 20 |and line|..\item |
|000019b0| 54 68 6f 73 65 20 69 6e | 20 74 68 65 20 60 60 2e |Those in| the ``.|
|000019c0| 63 78 72 65 66 27 27 20 | 66 69 6c 65 20 69 6e 20 |cxref'' |file in |
|000019d0| 74 68 65 20 63 75 72 72 | 65 6e 74 20 64 69 72 65 |the curr|ent dire|
|000019e0| 63 74 6f 72 79 2e 0a 5c | 69 74 65 6d 20 54 68 6f |ctory..\|item Tho|
|000019f0| 73 65 20 69 6e 20 74 68 | 65 20 60 60 2e 63 78 72 |se in th|e ``.cxr|
|00001a00| 65 66 27 27 20 66 69 6c | 65 20 69 6e 20 74 68 65 |ef'' fil|e in the|
|00001a10| 20 73 6f 75 72 63 65 20 | 74 72 65 65 20 72 6f 6f | source |tree roo|
|00001a20| 74 20 73 70 65 63 69 66 | 69 65 64 20 62 79 20 60 |t specif|ied by `|
|00001a30| 60 2d 52 27 27 2e 0a 5c | 65 6e 64 7b 65 6e 75 6d |`-R''..\|end{enum|
|00001a40| 65 72 61 74 65 7d 0a 0a | 54 68 69 73 20 6d 65 61 |erate}..|This mea|
|00001a50| 6e 73 20 74 68 61 74 20 | 69 6e 20 61 20 6d 75 6c |ns that |in a mul|
|00001a60| 74 69 2d 64 69 72 65 63 | 74 6f 72 79 20 73 6f 75 |ti-direc|tory sou|
|00001a70| 72 63 65 20 74 72 65 65 | 2c 20 65 61 63 68 20 73 |rce tree|, each s|
|00001a80| 75 62 2d 64 69 72 65 63 | 74 6f 72 79 20 63 61 6e |ub-direc|tory can|
|00001a90| 20 68 61 76 65 20 61 0a | 60 60 2e 63 78 72 65 66 | have a.|``.cxref|
|00001aa0| 27 27 20 66 69 6c 65 20 | 63 6f 6e 74 61 69 6e 69 |'' file |containi|
|00001ab0| 6e 67 20 6a 75 73 74 20 | 74 68 65 20 6c 69 6e 65 |ng just |the line|
|00001ac0| 20 60 60 2d 52 2e 2e 27 | 27 20 6f 72 20 61 70 70 | ``-R..'|' or app|
|00001ad0| 72 6f 70 72 69 61 74 65 | 2e 20 20 54 68 65 20 6d |ropriate|. The m|
|00001ae0| 61 69 6e 0a 64 69 72 65 | 63 74 6f 72 79 20 63 61 |ain.dire|ctory ca|
|00001af0| 6e 20 68 61 76 65 20 61 | 20 60 60 2e 63 78 72 65 |n have a| ``.cxre|
|00001b00| 66 27 27 20 66 69 6c 65 | 20 63 6f 6e 74 61 69 6e |f'' file| contain|
|00001b10| 69 6e 67 20 74 68 65 20 | 72 65 6d 61 69 6e 64 65 |ing the |remainde|
|00001b20| 72 20 6f 66 20 74 68 65 | 20 6f 70 74 69 6f 6e 73 |r of the| options|
|00001b30| 2e 20 20 54 68 69 73 0a | 72 65 6d 6f 76 65 73 20 |. This.|removes |
|00001b40| 63 6f 6d 70 6c 65 74 65 | 6c 79 20 74 68 65 20 6e |complete|ly the n|
|00001b50| 65 65 64 20 74 6f 20 68 | 61 76 65 20 61 6e 79 20 |eed to h|ave any |
|00001b60| 6f 70 74 69 6f 6e 73 20 | 6f 6e 20 74 68 65 20 63 |options |on the c|
|00001b70| 6f 6d 6d 61 6e 64 20 6c | 69 6e 65 20 61 70 61 72 |ommand l|ine apar|
|00001b80| 74 20 66 72 6f 6d 0a 74 | 68 65 20 73 6f 75 72 63 |t from.t|he sourc|
|00001b90| 65 20 66 69 6c 65 20 6e | 61 6d 65 73 2e 0a 0a 54 |e file n|ames...T|
|00001ba0| 68 65 20 66 6f 72 6d 61 | 74 20 6f 66 20 74 68 65 |he forma|t of the|
|00001bb0| 20 2e 63 78 72 65 66 20 | 66 69 6c 65 20 69 73 20 | .cxref |file is |
|00001bc0| 61 6e 79 20 6e 75 6d 62 | 65 72 20 6f 66 20 6c 69 |any numb|er of li|
|00001bd0| 6e 65 73 2c 20 65 61 63 | 68 20 6f 6e 65 20 63 6f |nes, eac|h one co|
|00001be0| 6e 74 61 69 6e 69 6e 67 | 20 61 0a 73 69 6e 67 6c |ntaining| a.singl|
|00001bf0| 65 20 63 6f 6d 6d 61 6e | 64 20 6c 69 6e 65 20 61 |e comman|d line a|
|00001c00| 72 67 75 6d 65 6e 74 20 | 28 65 71 75 69 76 61 6c |rgument |(equival|
|00001c10| 65 6e 74 20 74 6f 20 6f | 6e 65 20 6f 66 20 74 68 |ent to o|ne of th|
|00001c20| 65 20 61 72 67 76 29 2e | 20 20 54 68 65 20 6f 6e |e argv).| The on|
|00001c30| 6c 79 20 6f 70 74 69 6f | 6e 73 0a 74 68 61 74 20 |ly optio|ns.that |
|00001c40| 63 61 6e 6e 6f 74 20 62 | 65 20 75 73 65 64 20 61 |cannot b|e used a|
|00001c50| 72 65 20 74 68 65 20 6e | 61 6d 65 73 20 6f 66 20 |re the n|ames of |
|00001c60| 73 6f 75 72 63 65 20 66 | 69 6c 65 73 20 74 68 65 |source f|iles the|
|00001c70| 6d 73 65 6c 76 65 73 20 | 61 6e 64 20 74 68 65 20 |mselves |and the |
|00001c80| 60 60 2d 64 65 6c 65 74 | 65 27 27 0a 6f 70 74 69 |``-delet|e''.opti|
|00001c90| 6f 6e 2e 20 20 42 6c 61 | 6e 6b 20 6c 69 6e 65 73 |on. Bla|nk lines|
|00001ca0| 20 61 72 65 20 69 67 6e | 6f 72 65 64 20 61 6e 64 | are ign|ored and|
|00001cb0| 20 6c 69 6e 65 73 20 73 | 74 61 72 74 69 6e 67 20 | lines s|tarting |
|00001cc0| 77 69 74 68 20 61 20 60 | 5c 23 27 20 61 72 65 20 |with a `|\#' are |
|00001cd0| 63 6f 6d 6d 65 6e 74 73 | 2e 0a 0a 5c 73 65 63 74 |comments|...\sect|
|00001ce0| 69 6f 6e 7b 50 72 6f 67 | 72 61 6d 20 44 6f 63 75 |ion{Prog|ram Docu|
|00001cf0| 6d 65 6e 74 61 74 69 6f | 6e 20 43 6f 6d 6d 65 6e |mentatio|n Commen|
|00001d00| 74 73 7d 0a 0a 54 68 65 | 20 64 6f 63 75 6d 65 6e |ts}..The| documen|
|00001d10| 74 61 74 69 6f 6e 20 66 | 6f 72 20 74 68 65 20 70 |tation f|or the p|
|00001d20| 72 6f 67 72 61 6d 20 69 | 73 20 70 72 6f 64 75 63 |rogram i|s produc|
|00001d30| 65 64 20 66 72 6f 6d 20 | 63 6f 6d 6d 65 6e 74 73 |ed from |comments|
|00001d40| 20 69 6e 20 74 68 65 20 | 63 6f 64 65 20 74 68 61 | in the |code tha|
|00001d50| 74 20 61 72 65 0a 61 70 | 70 72 6f 70 72 69 61 74 |t are.ap|propriat|
|00001d60| 65 6c 79 20 66 6f 72 6d | 61 74 74 65 64 2e 20 20 |ely form|atted. |
|00001d70| 54 68 65 20 63 72 6f 73 | 73 20 72 65 66 65 72 65 |The cros|s refere|
|00001d80| 6e 63 69 6e 67 20 63 6f | 6d 65 73 20 66 72 6f 6d |ncing co|mes from|
|00001d90| 20 74 68 65 20 63 6f 64 | 65 20 69 74 73 65 6c 66 | the cod|e itself|
|00001da0| 20 61 6e 64 0a 72 65 71 | 75 69 72 65 73 20 6e 6f | and.req|uires no|
|00001db0| 20 65 78 74 72 61 20 77 | 6f 72 6b 2e 0a 0a 54 68 | extra w|ork...Th|
|00001dc0| 65 20 73 70 65 63 69 61 | 6c 20 63 6f 6d 6d 65 6e |e specia|l commen|
|00001dd0| 74 73 20 61 72 65 20 60 | 60 2f 2a 2a 2a 2a 20 2a |ts are `|`/**** *|
|00001de0| 2a 2a 2a 2f 27 27 20 28 | 66 6f 72 20 61 20 66 69 |***/'' (|for a fi|
|00001df0| 6c 65 29 20 61 6e 64 20 | 60 60 2f 2a 2b 2b 2b 2b |le) and |``/*++++|
|00001e00| 20 2b 2b 2b 2b 2a 2f 27 | 27 20 28 66 6f 72 20 61 | ++++*/'|' (for a|
|00001e10| 0a 64 61 74 61 20 6f 62 | 6a 65 63 74 29 20 61 6e |.data ob|ject) an|
|00001e20| 79 20 6e 75 6d 62 65 72 | 20 6f 66 20 60 60 2a 27 |y number| of ``*'|
|00001e30| 27 20 6f 72 20 60 60 2b | 27 27 20 63 61 6e 20 62 |' or ``+|'' can b|
|00001e40| 65 20 75 73 65 64 20 69 | 6e 73 69 64 65 20 6f 66 |e used i|nside of|
|00001e50| 20 74 68 65 20 73 74 61 | 6e 64 61 72 64 20 60 60 | the sta|ndard ``|
|00001e60| 2f 2a 27 27 0a 61 6e 64 | 20 60 60 2a 2f 27 27 20 |/*''.and| ``*/'' |
|00001e70| 63 6f 6d 6d 65 6e 74 20 | 64 65 6c 69 6d 69 74 65 |comment |delimite|
|00001e80| 72 73 20 69 6e 20 74 68 | 65 20 63 6f 6d 6d 65 6e |rs in th|e commen|
|00001e90| 74 73 2c 20 74 68 65 79 | 20 61 72 65 20 69 67 6e |ts, they| are ign|
|00001ea0| 6f 72 65 64 2e 0a 0a 49 | 66 20 61 20 63 6f 6d 6d |ored...I|f a comm|
|00001eb0| 65 6e 74 20 6c 69 6e 65 | 20 73 74 61 72 74 73 20 |ent line| starts |
|00001ec0| 77 69 74 68 20 77 68 69 | 74 65 73 70 61 63 65 20 |with whi|tespace |
|00001ed0| 61 6e 64 20 69 73 20 66 | 6f 6c 6c 6f 77 65 64 20 |and is f|ollowed |
|00001ee0| 62 79 20 60 2b 68 74 6d | 6c 2b 27 20 74 68 65 6e |by `+htm|l+' then|
|00001ef0| 20 74 68 65 0a 72 65 73 | 74 20 6f 66 20 74 68 65 | the.res|t of the|
|00001f00| 20 6c 69 6e 65 20 69 73 | 20 69 6e 63 6c 75 64 65 | line is| include|
|00001f10| 64 20 6f 6e 6c 79 20 69 | 6e 20 74 68 65 20 48 54 |d only i|n the HT|
|00001f20| 4d 4c 20 6f 75 74 70 75 | 74 2c 20 61 6e 64 20 69 |ML outpu|t, and i|
|00001f30| 73 20 6e 6f 74 20 70 72 | 6f 63 65 73 73 65 64 20 |s not pr|ocessed |
|00001f40| 73 6f 20 69 74 0a 63 61 | 6e 20 69 6e 63 6c 75 64 |so it.ca|n includ|
|00001f50| 65 20 48 54 4d 4c 20 6d | 61 72 6b 75 70 2c 20 60 |e HTML m|arkup, `|
|00001f60| 2d 68 74 6d 6c 2d 27 20 | 6d 65 61 6e 73 20 74 68 |-html-' |means th|
|00001f70| 61 74 20 74 68 65 20 72 | 65 73 74 20 6f 66 20 74 |at the r|est of t|
|00001f80| 68 65 20 6c 69 6e 65 20 | 69 73 20 69 6e 63 6c 75 |he line |is inclu|
|00001f90| 64 65 64 20 69 6e 0a 61 | 6c 6c 20 65 78 63 65 70 |ded in.a|ll excep|
|00001fa0| 74 20 74 68 65 20 48 54 | 4d 4c 20 6f 75 74 70 75 |t the HT|ML outpu|
|00001fb0| 74 2e 20 20 54 68 65 20 | 73 61 6d 65 20 61 70 70 |t. The |same app|
|00001fc0| 6c 69 65 73 20 74 6f 20 | 60 2b 6c 61 74 65 78 2b |lies to |`+latex+|
|00001fd0| 27 20 61 6e 64 20 60 2d | 6c 61 74 65 78 2d 27 2c |' and `-|latex-',|
|00001fe0| 0a 60 2b 6e 6f 6e 65 2b | 27 20 63 61 6e 20 62 65 |.`+none+|' can be|
|00001ff0| 20 75 73 65 64 20 66 6f | 72 20 6c 69 6e 65 73 20 | used fo|r lines |
|00002000| 6e 6f 74 20 74 6f 20 61 | 70 70 65 61 72 20 69 6e |not to a|ppear in|
|00002010| 20 61 6e 79 20 6f 75 74 | 70 75 74 2e 20 20 54 68 | any out|put. Th|
|00002020| 65 20 65 78 63 65 70 74 | 69 6f 6e 20 74 6f 0a 74 |e except|ion to.t|
|00002030| 68 69 73 20 69 73 20 74 | 68 61 74 20 74 68 65 20 |his is t|hat the |
|00002040| 72 61 77 20 6f 75 74 70 | 75 74 20 64 6f 65 73 20 |raw outp|ut does |
|00002050| 6e 6f 74 20 64 6f 20 61 | 6e 79 20 63 68 65 63 6b |not do a|ny check|
|00002060| 69 6e 67 20 61 6e 64 20 | 77 69 6c 6c 20 6f 75 74 |ing and |will out|
|00002070| 70 75 74 20 61 6c 6c 20 | 6c 69 6e 65 73 2e 0a 0a |put all |lines...|
|00002080| 49 6e 20 61 6e 79 20 73 | 69 74 75 61 74 69 6f 6e |In any s|ituation|
|00002090| 20 77 68 65 72 65 20 61 | 20 63 6f 6d 6d 65 6e 74 | where a| comment|
|000020a0| 20 66 6f 6c 6c 6f 77 73 | 20 61 20 60 60 2c 27 27 | follows| a ``,''|
|000020b0| 2c 20 60 60 3b 27 27 20 | 6f 72 20 60 60 29 27 27 |, ``;'' |or ``)''|
|000020c0| 20 73 65 70 61 72 61 74 | 65 64 20 6f 6e 6c 79 20 | separat|ed only |
|000020d0| 62 79 0a 73 70 61 63 65 | 73 20 61 6e 64 20 74 61 |by.space|s and ta|
|000020e0| 62 73 2c 20 74 68 65 20 | 63 6f 6d 6d 65 6e 74 20 |bs, the |comment |
|000020f0| 69 73 20 70 75 73 68 65 | 64 20 74 6f 20 62 65 66 |is pushe|d to bef|
|00002100| 6f 72 65 20 74 68 65 20 | 70 75 6e 63 74 75 61 74 |ore the |punctuat|
|00002110| 69 6f 6e 20 74 6f 20 61 | 70 70 6c 79 20 74 6f 0a |ion to a|pply to.|
|00002120| 74 68 65 20 6f 62 6a 65 | 63 74 20 74 68 65 72 65 |the obje|ct there|
|00002130| 2e 0a 0a 54 68 65 20 70 | 72 6f 67 72 61 6d 20 69 |...The p|rogram i|
|00002140| 73 20 69 6d 70 6c 65 6d | 65 6e 74 65 64 20 75 73 |s implem|ented us|
|00002150| 69 6e 67 20 61 20 66 75 | 6c 6c 20 41 4e 53 49 20 |ing a fu|ll ANSI |
|00002160| 43 20 67 72 61 6d 6d 61 | 72 20 70 61 72 73 65 72 |C gramma|r parser|
|00002170| 20 77 69 74 68 20 73 6f | 6d 65 20 47 43 43 0a 65 | with so|me GCC.e|
|00002180| 78 74 65 6e 73 69 6f 6e | 73 2c 20 74 68 69 73 20 |xtension|s, this |
|00002190| 6d 65 61 6e 73 20 74 68 | 61 74 20 74 68 65 20 73 |means th|at the s|
|000021a0| 74 79 6c 65 20 6f 66 20 | 74 68 65 20 63 6f 64 65 |tyle of |the code|
|000021b0| 20 69 73 20 75 6e 69 6d | 70 6f 72 74 61 6e 74 2c | is unim|portant,|
|000021c0| 20 6f 6e 6c 79 20 74 68 | 65 0a 63 6f 6e 74 65 6e | only th|e.conten|
|000021d0| 74 20 61 6e 64 20 63 6f | 6d 6d 65 6e 74 73 2e 0a |t and co|mments..|
|000021e0| 0a 5c 73 65 63 74 69 6f | 6e 7b 41 75 74 6f 6d 61 |.\sectio|n{Automa|
|000021f0| 74 65 64 20 43 6f 6d 6d | 65 6e 74 20 49 6e 73 65 |ted Comm|ent Inse|
|00002200| 72 74 69 6f 6e 7d 0a 0a | 54 6f 20 73 69 6d 70 6c |rtion}..|To simpl|
|00002210| 69 66 79 20 74 68 65 20 | 69 6e 73 65 72 74 69 6f |ify the |insertio|
|00002220| 6e 20 6f 66 20 63 6f 6d | 6d 65 6e 74 73 20 74 68 |n of com|ments th|
|00002230| 61 74 20 77 69 6c 6c 20 | 62 65 20 70 61 72 73 65 |at will |be parse|
|00002240| 64 20 62 79 20 63 78 72 | 65 66 2c 20 74 68 65 20 |d by cxr|ef, the |
|00002250| 66 69 6c 65 0a 63 78 72 | 65 66 2e 65 6c 20 70 72 |file.cxr|ef.el pr|
|00002260| 6f 76 69 64 65 73 20 61 | 20 6e 75 6d 62 65 72 20 |ovides a| number |
|00002270| 6f 66 20 45 6d 61 63 73 | 20 6c 69 73 70 20 66 75 |of Emacs| lisp fu|
|00002280| 6e 63 74 69 6f 6e 73 2e | 20 20 54 6f 20 75 73 65 |nctions.| To use|
|00002290| 20 74 68 65 6d 20 61 64 | 64 20 74 68 65 20 6c 69 | them ad|d the li|
|000022a0| 6e 65 0a 7b 5c 74 74 20 | 28 6c 6f 61 64 20 22 63 |ne.{\tt |(load "c|
|000022b0| 78 72 65 66 22 29 7d 20 | 74 6f 20 79 6f 75 72 20 |xref")} |to your |
|000022c0| 60 60 2e 65 6d 61 63 73 | 27 27 20 66 69 6c 65 20 |``.emacs|'' file |
|000022d0| 6f 72 20 74 79 70 65 20 | 7b 5c 74 74 20 4d 2d 78 |or type |{\tt M-x|
|000022e0| 20 6c 6f 61 64 2d 66 69 | 6c 65 20 63 78 72 65 66 | load-fi|le cxref|
|000022f0| 2e 65 6c 7d 20 66 72 6f | 6d 0a 77 69 74 68 69 6e |.el} fro|m.within|
|00002300| 20 45 6d 61 63 73 2e 0a | 0a 54 68 65 20 66 75 6e | Emacs..|.The fun|
|00002310| 63 74 69 6f 6e 73 20 61 | 6e 64 20 6b 65 79 20 62 |ctions a|nd key b|
|00002320| 69 6e 64 69 6e 67 73 20 | 61 72 65 3a 0a 5c 62 65 |indings |are:.\be|
|00002330| 67 69 6e 7b 6c 69 73 74 | 7d 7b 7d 7b 5c 6c 65 66 |gin{list|}{}{\lef|
|00002340| 74 6d 61 72 67 69 6e 3d | 31 2e 33 69 6e 20 5c 6c |tmargin=|1.3in \l|
|00002350| 61 62 65 6c 77 69 64 74 | 68 3d 32 2e 35 69 6e 7d |abelwidt|h=2.5in}|
|00002360| 0a 5c 69 74 65 6d 5b 7b | 5c 69 74 20 43 6f 6e 74 |.\item[{|\it Cont|
|00002370| 72 6f 6c 2d 43 20 43 6f | 6e 74 72 6f 6c 2d 46 7d |rol-C Co|ntrol-F}|
|00002380| 5d 0a 41 64 64 73 20 66 | 69 6c 65 20 63 6f 6d 6d |].Adds f|ile comm|
|00002390| 65 6e 74 73 2c 20 61 20 | 2f 2a 2a 20 2a 2a 2f 20 |ents, a |/** **/ |
|000023a0| 68 65 61 64 65 72 20 61 | 74 20 74 68 65 20 74 6f |header a|t the to|
|000023b0| 70 20 6f 66 20 74 68 65 | 0a 66 69 6c 65 20 61 6e |p of the|.file an|
|000023c0| 64 20 69 66 20 69 74 20 | 69 73 20 61 20 2e 68 20 |d if it |is a .h |
|000023d0| 66 69 6c 65 20 74 68 65 | 6e 20 69 74 20 61 6c 73 |file the|n it als|
|000023e0| 6f 20 61 64 64 73 20 61 | 20 5c 23 69 66 6e 64 65 |o adds a| \#ifnde|
|000023f0| 66 2c 0a 5c 23 64 65 66 | 69 6e 65 20 61 74 20 74 |f,.\#def|ine at t|
|00002400| 68 65 20 62 65 67 69 6e | 6e 69 6e 67 20 61 6e 64 |he begin|ning and|
|00002410| 20 5c 23 65 6e 64 69 66 | 20 61 74 20 74 68 65 20 | \#endif| at the |
|00002420| 65 6e 64 20 74 6f 20 73 | 74 6f 70 0a 6d 75 6c 74 |end to s|top.mult|
|00002430| 69 70 6c 65 20 69 6e 63 | 6c 75 73 69 6f 6e 73 2e |iple inc|lusions.|
|00002440| 0a 5c 69 74 65 6d 5b 7b | 5c 69 74 20 43 6f 6e 74 |.\item[{|\it Cont|
|00002450| 72 6f 6c 2d 43 20 66 7d | 5d 0a 41 64 64 73 20 63 |rol-C f}|].Adds c|
|00002460| 6f 6d 6d 65 6e 74 73 20 | 74 6f 20 61 20 66 75 6e |omments |to a fun|
|00002470| 63 74 69 6f 6e 2c 20 74 | 68 65 20 63 75 72 73 6f |ction, t|he curso|
|00002480| 72 20 6d 75 73 74 20 62 | 65 20 6f 6e 20 74 68 65 |r must b|e on the|
|00002490| 0a 6c 69 6e 65 20 63 6f | 6e 74 61 69 6e 69 6e 67 |.line co|ntaining|
|000024a0| 20 74 68 65 20 73 74 61 | 72 74 20 6f 66 20 74 68 | the sta|rt of th|
|000024b0| 65 20 66 75 6e 63 74 69 | 6f 6e 20 64 65 66 69 6e |e functi|on defin|
|000024c0| 69 74 69 6f 6e 20 77 68 | 65 6e 0a 74 68 69 73 20 |ition wh|en.this |
|000024d0| 66 75 6e 63 74 69 6f 6e | 20 69 73 20 63 61 6c 6c |function| is call|
|000024e0| 65 64 2e 20 20 54 68 65 | 20 2f 2a 2b 20 2e 2e 2e |ed. The| /*+ ...|
|000024f0| 20 2b 2a 2f 20 63 6f 6d | 6d 65 6e 74 20 74 68 61 | +*/ com|ment tha|
|00002500| 74 20 69 73 0a 61 64 64 | 65 64 20 69 73 20 6f 66 |t is.add|ed is of|
|00002510| 20 74 68 65 20 68 65 61 | 64 65 72 20 74 79 70 65 | the hea|der type|
|00002520| 20 28 73 65 65 20 74 68 | 65 20 65 78 61 6d 70 6c | (see th|e exampl|
|00002530| 65 73 29 20 6e 6f 74 20 | 69 6e 6c 69 6e 65 2e 0a |es) not |inline..|
|00002540| 5c 69 74 65 6d 5b 7b 5c | 69 74 20 43 6f 6e 74 72 |\item[{\|it Contr|
|00002550| 6f 6c 2d 43 20 76 7d 5d | 0a 41 64 64 73 20 61 20 |ol-C v}]|.Adds a |
|00002560| 6c 65 61 64 69 6e 67 20 | 63 6f 6d 6d 65 6e 74 20 |leading |comment |
|00002570| 74 6f 20 74 68 65 20 76 | 61 72 69 61 62 6c 65 20 |to the v|ariable |
|00002580| 6f 72 20 6f 74 68 65 72 | 20 64 65 66 69 6e 69 74 |or other| definit|
|00002590| 69 6f 6e 0a 6f 6e 20 74 | 68 65 20 63 75 72 72 65 |ion.on t|he curre|
|000025a0| 6e 74 20 6c 69 6e 65 2e | 0a 5c 69 74 65 6d 5b 7b |nt line.|.\item[{|
|000025b0| 5c 69 74 20 43 6f 6e 74 | 72 6f 6c 2d 43 20 65 7d |\it Cont|rol-C e}|
|000025c0| 5d 0a 41 64 64 73 20 61 | 20 74 72 61 69 6c 69 6e |].Adds a| trailin|
|000025d0| 67 20 63 6f 6d 6d 65 6e | 74 20 61 74 20 74 68 65 |g commen|t at the|
|000025e0| 20 65 6e 64 20 6f 66 20 | 74 68 65 20 6c 69 6e 65 | end of |the line|
|000025f0| 2e 0a 5c 69 74 65 6d 5b | 7b 5c 69 74 20 43 6f 6e |..\item[|{\it Con|
|00002600| 74 72 6f 6c 2d 43 20 69 | 7d 5d 0a 41 64 64 73 20 |trol-C i|}].Adds |
|00002610| 61 6e 20 69 6e 6c 69 6e | 65 20 63 6f 6d 6d 65 6e |an inlin|e commen|
|00002620| 74 20 74 68 61 74 20 69 | 73 20 69 67 6e 6f 72 65 |t that i|s ignore|
|00002630| 64 20 62 79 20 63 78 72 | 65 66 2e 0a 5c 65 6e 64 |d by cxr|ef..\end|
|00002640| 7b 6c 69 73 74 7d 0a 0a | 5c 73 65 63 74 69 6f 6e |{list}..|\section|
|00002650| 7b 43 20 50 72 65 70 72 | 6f 63 65 73 73 6f 72 7d |{C Prepr|ocessor}|
|00002660| 0a 0a 54 6f 20 69 6d 70 | 72 6f 76 65 20 74 68 65 |..To imp|rove the|
|00002670| 20 6f 75 74 70 75 74 20 | 74 68 61 74 20 69 73 20 | output |that is |
|00002680| 61 76 61 69 6c 61 62 6c | 65 20 61 20 6d 6f 64 69 |availabl|e a modi|
|00002690| 66 69 65 64 20 76 65 72 | 73 69 6f 6e 20 6f 66 20 |fied ver|sion of |
|000026a0| 74 68 65 20 47 4e 55 20 | 43 50 50 20 56 32 2e 37 |the GNU |CPP V2.7|
|000026b0| 2e 32 0a 69 73 20 73 75 | 70 70 6c 69 65 64 20 28 |.2.is su|pplied (|
|000026c0| 6e 61 6d 65 64 20 63 78 | 72 65 66 2d 63 70 70 29 |named cx|ref-cpp)|
|000026d0| 2e 0a 0a 54 68 69 73 20 | 6d 6f 64 69 66 69 65 64 |...This |modified|
|000026e0| 20 43 20 70 72 65 70 72 | 6f 63 65 73 73 6f 72 20 | C prepr|ocessor |
|000026f0| 61 6c 6c 6f 77 73 20 66 | 6f 72 20 61 20 66 69 6e |allows f|or a fin|
|00002700| 65 72 20 63 6f 6e 74 72 | 6f 6c 20 6f 76 65 72 20 |er contr|ol over |
|00002710| 73 6f 6d 65 20 66 65 61 | 74 75 72 65 73 20 6f 66 |some fea|tures of|
|00002720| 0a 74 68 65 20 70 72 65 | 70 72 6f 63 65 73 73 69 |.the pre|processi|
|00002730| 6e 67 20 74 68 61 74 20 | 61 72 65 20 6e 6f 74 20 |ng that |are not |
|00002740| 69 6d 70 6f 72 74 61 6e | 74 20 66 6f 72 20 61 20 |importan|t for a |
|00002750| 63 6f 6d 70 69 6c 65 72 | 2e 20 20 49 6e 20 61 20 |compiler|. In a |
|00002760| 73 74 61 6e 64 61 72 64 | 0a 70 72 65 70 72 6f 63 |standard|.preproc|
|00002770| 65 73 73 6f 72 2c 20 74 | 68 65 20 70 72 65 70 72 |essor, t|he prepr|
|00002780| 6f 63 65 73 73 6f 72 20 | 64 69 72 65 63 74 69 76 |ocessor |directiv|
|00002790| 65 73 20 61 72 65 20 69 | 6e 74 65 6e 64 65 64 20 |es are i|ntended |
|000027a0| 66 6f 72 20 75 73 65 20 | 6f 6e 6c 79 20 62 79 20 |for use |only by |
|000027b0| 74 68 65 0a 70 72 65 70 | 72 6f 63 65 73 73 6f 72 |the.prep|rocessor|
|000027c0| 2c 20 73 6f 20 70 61 73 | 73 69 6e 67 20 74 68 65 |, so pas|sing the|
|000027d0| 20 69 6e 66 6f 72 6d 61 | 74 69 6f 6e 20 74 68 72 | informa|tion thr|
|000027e0| 6f 75 67 68 20 69 73 20 | 6e 6f 74 20 69 6d 70 6f |ough is |not impo|
|000027f0| 72 74 61 6e 74 2e 0a 0a | 57 69 74 68 20 63 78 72 |rtant...|With cxr|
|00002800| 65 66 2d 63 70 70 2c 20 | 74 68 65 72 65 20 61 72 |ef-cpp, |there ar|
|00002810| 65 20 74 77 6f 20 66 65 | 61 74 75 72 65 73 20 74 |e two fe|atures t|
|00002820| 68 61 74 20 61 72 65 20 | 64 69 66 66 65 72 65 6e |hat are |differen|
|00002830| 74 20 74 6f 20 74 68 65 | 20 73 74 61 6e 64 61 72 |t to the| standar|
|00002840| 64 20 47 4e 55 0a 43 50 | 50 3a 0a 0a 5c 62 65 67 |d GNU.CP|P:..\beg|
|00002850| 69 6e 7b 65 6e 75 6d 65 | 72 61 74 65 7d 0a 5c 69 |in{enume|rate}.\i|
|00002860| 74 65 6d 0a 54 68 65 20 | 5c 23 69 6e 63 6c 75 64 |tem.The |\#includ|
|00002870| 65 20 64 69 72 65 63 74 | 69 76 65 73 20 66 72 6f |e direct|ives fro|
|00002880| 6d 20 74 68 65 20 66 69 | 6c 65 20 61 72 65 20 6f |m the fi|le are o|
|00002890| 75 74 70 75 74 20 69 6e | 20 74 68 65 20 73 61 6d |utput in| the sam|
|000028a0| 65 20 77 61 79 20 61 73 | 20 74 68 65 0a 5c 23 64 |e way as| the.\#d|
|000028b0| 65 66 69 6e 65 73 20 61 | 72 65 20 6f 75 74 70 75 |efines a|re outpu|
|000028c0| 74 2e 20 20 41 6e 20 65 | 78 74 72 61 20 66 6c 61 |t. An e|xtra fla|
|000028d0| 67 20 68 61 73 20 62 65 | 65 6e 20 61 64 64 65 64 |g has be|en added|
|000028e0| 20 74 6f 20 63 70 70 20 | 74 6f 20 64 6f 20 74 68 | to cpp |to do th|
|000028f0| 69 73 2c 20 27 2d 64 49 | 27 2c 0a 69 74 20 77 6f |is, '-dI|',.it wo|
|00002900| 72 6b 73 20 69 6e 20 74 | 68 65 20 73 61 6d 65 20 |rks in t|he same |
|00002910| 77 61 79 20 61 73 20 74 | 68 65 20 65 78 69 73 74 |way as t|he exist|
|00002920| 69 6e 67 20 27 2d 64 44 | 27 20 66 6c 61 67 20 66 |ing '-dD|' flag f|
|00002930| 6f 72 20 5c 23 64 65 66 | 69 6e 65 73 2e 0a 5c 69 |or \#def|ines..\i|
|00002940| 74 65 6d 0a 43 6f 6d 6d | 65 6e 74 73 20 74 72 61 |tem.Comm|ents tra|
|00002950| 69 6c 69 6e 67 20 61 20 | 5c 23 69 6e 63 6c 75 64 |iling a |\#includ|
|00002960| 65 20 6f 72 20 61 20 5c | 23 64 65 66 69 6e 65 20 |e or a \|#define |
|00002970| 61 72 65 20 64 72 6f 70 | 70 65 64 20 77 69 74 68 |are drop|ped with|
|00002980| 20 47 4e 55 20 43 50 50 | 20 65 76 65 6e 20 69 66 | GNU CPP| even if|
|00002990| 20 2d 43 0a 69 73 20 75 | 73 65 64 2e 20 54 68 69 | -C.is u|sed. Thi|
|000029a0| 73 20 69 73 20 6e 6f 74 | 20 69 6d 70 6f 72 74 61 |s is not| importa|
|000029b0| 6e 74 20 77 68 69 6c 65 | 20 63 6f 6d 70 69 6c 69 |nt while| compili|
|000029c0| 6e 67 20 62 75 74 20 69 | 73 20 75 73 65 66 75 6c |ng but i|s useful|
|000029d0| 20 66 6f 72 20 64 6f 63 | 75 6d 65 6e 74 69 6e 67 | for doc|umenting|
|000029e0| 2e 0a 5c 65 6e 64 7b 65 | 6e 75 6d 65 72 61 74 65 |..\end{e|numerate|
|000029f0| 7d 0a 0a 5c 73 65 63 74 | 69 6f 6e 7b 43 72 6f 73 |}..\sect|ion{Cros|
|00002a00| 73 20 52 65 66 65 72 65 | 6e 63 69 6e 67 7d 0a 0a |s Refere|ncing}..|
|00002a10| 54 68 65 20 63 72 6f 73 | 73 20 72 65 66 65 72 65 |The cros|s refere|
|00002a20| 6e 63 69 6e 67 20 69 73 | 20 70 65 72 66 6f 72 6d |ncing is| perform|
|00002a30| 65 64 20 66 6f 72 20 74 | 68 65 20 66 6f 6c 6c 6f |ed for t|he follo|
|00002a40| 77 69 6e 67 20 69 74 65 | 6d 73 0a 5c 62 65 67 69 |wing ite|ms.\begi|
|00002a50| 6e 7b 6c 69 73 74 7d 7b | 7d 7b 5c 6c 65 66 74 6d |n{list}{|}{\leftm|
|00002a60| 61 72 67 69 6e 3d 31 69 | 6e 20 5c 6c 61 62 65 6c |argin=1i|n \label|
|00002a70| 77 69 64 74 68 3d 31 2e | 35 69 6e 7d 0a 5c 69 74 |width=1.|5in}.\it|
|00002a80| 65 6d 5b 46 69 6c 65 73 | 5d 0a 5c 62 65 67 69 6e |em[Files|].\begin|
|00002a90| 7b 69 74 65 6d 69 7a 65 | 7d 0a 5c 69 74 65 6d 20 |{itemize|}.\item |
|00002aa0| 54 68 65 20 66 69 6c 65 | 73 20 74 68 61 74 20 74 |The file|s that t|
|00002ab0| 68 65 20 63 75 72 72 65 | 6e 74 20 66 69 6c 65 20 |he curre|nt file |
|00002ac0| 69 73 20 69 6e 63 6c 75 | 64 65 64 20 69 6e 0a 28 |is inclu|ded in.(|
|00002ad0| 65 76 65 6e 20 77 68 65 | 6e 20 69 6e 63 6c 75 64 |even whe|n includ|
|00002ae0| 65 64 20 76 69 61 20 6f | 74 68 65 72 20 66 69 6c |ed via o|ther fil|
|00002af0| 65 73 29 2e 0a 5c 65 6e | 64 7b 69 74 65 6d 69 7a |es)..\en|d{itemiz|
|00002b00| 65 7d 0a 5c 69 74 65 6d | 5b 5c 23 69 6e 63 6c 75 |e}.\item|[\#inclu|
|00002b10| 64 65 73 5d 0a 5c 62 65 | 67 69 6e 7b 69 74 65 6d |des].\be|gin{item|
|00002b20| 69 7a 65 7d 0a 5c 69 74 | 65 6d 20 46 69 6c 65 73 |ize}.\it|em Files|
|00002b30| 20 69 6e 63 6c 75 64 65 | 64 20 69 6e 20 74 68 65 | include|d in the|
|00002b40| 20 63 75 72 72 65 6e 74 | 20 66 69 6c 65 2e 0a 5c | current| file..\|
|00002b50| 69 74 65 6d 20 46 69 6c | 65 73 20 69 6e 63 6c 75 |item Fil|es inclu|
|00002b60| 64 65 64 20 62 79 20 74 | 68 65 73 65 20 66 69 6c |ded by t|hese fil|
|00002b70| 65 73 20 65 74 63 2e 0a | 5c 65 6e 64 7b 69 74 65 |es etc..|\end{ite|
|00002b80| 6d 69 7a 65 7d 0a 5c 69 | 74 65 6d 5b 56 61 72 69 |mize}.\i|tem[Vari|
|00002b90| 61 62 6c 65 73 5d 0a 5c | 62 65 67 69 6e 7b 69 74 |ables].\|begin{it|
|00002ba0| 65 6d 69 7a 65 7d 0a 5c | 69 74 65 6d 20 54 68 65 |emize}.\|item The|
|00002bb0| 20 6c 6f 63 61 74 69 6f | 6e 20 6f 66 20 74 68 65 | locatio|n of the|
|00002bc0| 20 64 65 66 69 6e 69 74 | 69 6f 6e 20 6f 66 20 65 | definit|ion of e|
|00002bd0| 78 74 65 72 6e 61 6c 20 | 76 61 72 69 61 62 6c 65 |xternal |variable|
|00002be0| 73 2e 0a 5c 69 74 65 6d | 20 54 68 65 20 66 69 6c |s..\item| The fil|
|00002bf0| 65 73 20 74 68 61 74 20 | 68 61 76 65 20 76 69 73 |es that |have vis|
|00002c00| 69 62 69 6c 69 74 79 20 | 6f 66 20 67 6c 6f 62 61 |ibility |of globa|
|00002c10| 6c 20 76 61 72 69 61 62 | 6c 65 73 2e 0a 5c 69 74 |l variab|les..\it|
|00002c20| 65 6d 20 54 68 65 20 66 | 69 6c 65 73 20 2f 20 66 |em The f|iles / f|
|00002c30| 75 6e 63 74 69 6f 6e 73 | 20 74 68 61 74 20 75 73 |unctions| that us|
|00002c40| 65 20 74 68 65 20 76 61 | 72 69 61 62 6c 65 2e 0a |e the va|riable..|
|00002c50| 5c 65 6e 64 7b 69 74 65 | 6d 69 7a 65 7d 0a 5c 69 |\end{ite|mize}.\i|
|00002c60| 74 65 6d 5b 46 75 6e 63 | 74 69 6f 6e 73 5d 0a 5c |tem[Func|tions].\|
|00002c70| 62 65 67 69 6e 7b 69 74 | 65 6d 69 7a 65 7d 0a 5c |begin{it|emize}.\|
|00002c80| 69 74 65 6d 20 54 68 65 | 20 66 69 6c 65 20 74 68 |item The| file th|
|00002c90| 61 74 20 74 68 65 20 66 | 75 6e 63 74 69 6f 6e 20 |at the f|unction |
|00002ca0| 69 73 20 70 72 6f 74 6f | 74 79 70 65 64 20 69 6e |is proto|typed in|
|00002cb0| 2e 0a 5c 69 74 65 6d 20 | 54 68 65 20 66 75 6e 63 |..\item |The func|
|00002cc0| 74 69 6f 6e 73 20 74 68 | 61 74 20 74 68 65 20 66 |tions th|at the f|
|00002cd0| 75 6e 63 74 69 6f 6e 20 | 63 61 6c 6c 73 2e 0a 5c |unction |calls..\|
|00002ce0| 69 74 65 6d 20 54 68 65 | 20 66 75 6e 63 74 69 6f |item The| functio|
|00002cf0| 6e 73 20 74 68 61 74 20 | 63 61 6c 6c 20 74 68 65 |ns that |call the|
|00002d00| 20 66 75 6e 63 74 69 6f | 6e 2e 0a 5c 69 74 65 6d | functio|n..\item|
|00002d10| 20 54 68 65 20 66 69 6c | 65 73 20 61 6e 64 20 66 | The fil|es and f|
|00002d20| 75 6e 63 74 69 6f 6e 73 | 20 74 68 61 74 20 72 65 |unctions| that re|
|00002d30| 66 65 72 65 6e 63 65 20 | 74 68 65 20 66 75 6e 63 |ference |the func|
|00002d40| 74 69 6f 6e 2e 0a 5c 69 | 74 65 6d 20 54 68 65 20 |tion..\i|tem The |
|00002d50| 76 61 72 69 61 62 6c 65 | 73 20 74 68 61 74 20 61 |variable|s that a|
|00002d60| 72 65 20 75 73 65 64 20 | 69 6e 20 74 68 65 20 66 |re used |in the f|
|00002d70| 75 6e 63 74 69 6f 6e 2e | 0a 5c 65 6e 64 7b 69 74 |unction.|.\end{it|
|00002d80| 65 6d 69 7a 65 7d 0a 5c | 65 6e 64 7b 6c 69 73 74 |emize}.\|end{list|
|00002d90| 7d 0a 45 61 63 68 20 6f | 66 20 74 68 65 73 65 20 |}.Each o|f these |
|00002da0| 69 74 65 6d 73 20 69 73 | 20 63 72 6f 73 73 20 72 |items is| cross r|
|00002db0| 65 66 65 72 65 6e 63 65 | 64 20 69 6e 20 74 68 65 |eference|d in the|
|00002dc0| 20 6f 75 74 70 75 74 2e | 0a 0a 54 68 65 20 63 72 | output.|..The cr|
|00002dd0| 6f 73 73 20 72 65 66 65 | 72 65 6e 63 69 6e 67 20 |oss refe|rencing |
|00002de0| 75 73 65 73 20 66 69 6c | 65 73 20 60 63 78 72 65 |uses fil|es `cxre|
|00002df0| 66 2e 76 61 72 69 61 62 | 6c 65 27 2c 20 60 63 78 |f.variab|le', `cx|
|00002e00| 72 65 66 2e 66 75 6e 63 | 74 69 6f 6e 27 2c 0a 60 |ref.func|tion',.`|
|00002e10| 63 78 72 65 66 2e 69 6e | 63 6c 75 64 65 27 20 61 |cxref.in|clude' a|
|00002e20| 6e 64 20 60 63 78 72 65 | 66 2e 74 79 70 65 64 65 |nd `cxre|f.typede|
|00002e30| 66 27 20 69 6e 20 74 68 | 65 20 6f 75 74 70 75 74 |f' in th|e output|
|00002e40| 20 64 69 72 65 63 74 6f | 72 79 2e 0a 0a 54 68 65 | directo|ry...The|
|00002e50| 73 65 20 61 72 65 20 61 | 20 63 6f 6d 70 6c 65 74 |se are a| complet|
|00002e60| 65 20 6c 69 73 74 20 6f | 66 20 74 68 65 20 66 75 |e list o|f the fu|
|00002e70| 6e 63 74 69 6f 6e 20 61 | 6e 64 20 76 61 72 69 61 |nction a|nd varia|
|00002e80| 62 6c 65 20 75 73 61 67 | 65 20 69 6e 20 74 68 65 |ble usag|e in the|
|00002e90| 20 70 72 6f 67 72 61 6d | 20 61 6e 64 0a 63 6f 75 | program| and.cou|
|00002ea0| 6c 64 20 62 65 20 75 73 | 65 64 20 74 6f 20 67 65 |ld be us|ed to ge|
|00002eb0| 6e 65 72 61 74 65 20 61 | 20 66 75 6e 63 74 69 6f |nerate a| functio|
|00002ec0| 6e 20 63 61 6c 6c 20 68 | 69 65 72 61 72 63 68 79 |n call h|ierarchy|
|00002ed0| 20 6f 72 20 76 61 72 69 | 61 62 6c 65 20 75 73 61 | or vari|able usa|
|00002ee0| 67 65 20 64 69 61 67 72 | 61 6d 0a 66 6f 72 20 65 |ge diagr|am.for e|
|00002ef0| 78 61 6d 70 6c 65 2e 0a | 0a 54 77 6f 20 63 78 72 |xample..|.Two cxr|
|00002f00| 65 66 20 70 61 73 73 65 | 73 20 6f 66 20 65 61 63 |ef passe|s of eac|
|00002f10| 68 20 66 69 6c 65 20 69 | 73 20 6e 65 65 64 65 64 |h file i|s needed|
|00002f20| 2c 20 74 68 65 20 66 69 | 72 73 74 20 74 6f 20 62 |, the fi|rst to b|
|00002f30| 75 69 6c 64 20 75 70 20 | 74 68 65 20 63 72 6f 73 |uild up |the cros|
|00002f40| 73 0a 72 65 66 65 72 65 | 6e 63 69 6e 67 20 66 69 |s.refere|ncing fi|
|00002f50| 6c 65 73 20 61 6e 64 20 | 74 68 65 20 73 65 63 6f |les and |the seco|
|00002f60| 6e 64 20 74 6f 20 75 73 | 65 20 74 68 65 6d 2e 0a |nd to us|e them..|
|00002f70| 0a 7b 5c 69 74 20 28 54 | 68 65 20 66 69 6c 65 20 |.{\it (T|he file |
|00002f80| 6e 61 6d 65 73 20 61 72 | 65 20 64 69 66 66 65 72 |names ar|e differ|
|00002f90| 65 6e 74 20 69 66 20 74 | 68 65 20 60 60 2d 4e 27 |ent if t|he ``-N'|
|00002fa0| 27 20 6f 70 74 69 6f 6e | 20 69 73 20 75 73 65 64 |' option| is used|
|00002fb0| 2e 29 7d 0a 0a 5c 73 65 | 63 74 69 6f 6e 7b 5c 4c |.)}..\se|ction{\L|
|00002fc0| 61 54 65 58 20 4f 75 74 | 70 75 74 7d 0a 0a 54 68 |aTeX Out|put}..Th|
|00002fd0| 65 20 64 65 66 61 75 6c | 74 20 5c 4c 61 54 65 58 |e defaul|t \LaTeX|
|00002fe0| 20 6f 75 74 70 75 74 20 | 69 73 20 61 20 66 69 6c | output |is a fil|
|00002ff0| 65 20 66 6f 72 20 65 61 | 63 68 20 6f 66 20 74 68 |e for ea|ch of th|
|00003000| 65 20 73 6f 75 72 63 65 | 20 66 69 6c 65 73 20 77 |e source| files w|
|00003010| 69 74 68 20 6f 6e 65 20 | 65 78 74 72 61 0a 66 69 |ith one |extra.fi|
|00003020| 6c 65 20 60 60 63 78 72 | 65 66 2e 74 65 78 27 27 |le ``cxr|ef.tex''|
|00003030| 20 74 68 61 74 20 69 6e | 63 6c 75 64 65 73 20 65 | that in|cludes e|
|00003040| 61 63 68 20 6f 66 20 74 | 68 65 20 6f 74 68 65 72 |ach of t|he other|
|00003050| 20 66 69 6c 65 73 2e 20 | 20 54 68 69 73 20 69 73 | files. | This is|
|00003060| 20 74 6f 20 61 6c 6c 6f | 77 20 61 0a 6d 61 6b 65 | to allo|w a.make|
|00003070| 66 69 6c 65 20 74 6f 20 | 6f 6e 6c 79 20 75 70 64 |file to |only upd|
|00003080| 61 74 65 20 74 68 65 20 | 63 68 61 6e 67 65 64 20 |ate the |changed |
|00003090| 66 69 6c 65 73 20 28 61 | 6c 74 68 6f 75 67 68 20 |files (a|lthough |
|000030a0| 74 68 65 20 72 65 66 65 | 72 65 6e 63 65 73 20 6d |the refe|rences m|
|000030b0| 61 79 20 72 65 71 75 69 | 72 65 0a 61 6c 6c 20 6f |ay requi|re.all o|
|000030c0| 66 20 74 68 65 20 66 69 | 6c 65 73 20 74 6f 20 62 |f the fi|les to b|
|000030d0| 65 20 63 68 65 63 6b 65 | 64 20 61 67 61 69 6e 29 |e checke|d again)|
|000030e0| 2e 20 20 57 68 65 6e 20 | 74 68 65 20 63 78 72 65 |. When |the cxre|
|000030f0| 66 2e 74 65 78 20 66 69 | 6c 65 20 68 61 73 20 62 |f.tex fi|le has b|
|00003100| 65 65 6e 20 77 72 69 74 | 74 65 6e 0a 69 74 20 63 |een writ|ten.it c|
|00003110| 61 6e 20 62 65 20 6d 6f | 64 69 66 69 65 64 20 62 |an be mo|dified b|
|00003120| 79 20 74 68 65 20 75 73 | 65 72 2c 20 61 6e 79 20 |y the us|er, any |
|00003130| 6e 65 77 20 66 69 6c 65 | 73 20 74 68 61 74 20 61 |new file|s that a|
|00003140| 72 65 20 61 64 64 65 64 | 20 61 72 65 20 61 64 64 |re added| are add|
|00003150| 65 64 20 61 74 20 74 68 | 65 0a 65 6e 64 20 6f 66 |ed at th|e.end of|
|00003160| 20 74 68 65 20 73 6f 75 | 72 63 65 20 63 6f 64 65 | the sou|rce code|
|00003170| 20 73 65 63 74 69 6f 6e | 2c 20 74 68 65 20 72 65 | section|, the re|
|00003180| 73 74 20 6f 66 20 74 68 | 65 20 66 69 6c 65 20 62 |st of th|e file b|
|00003190| 65 69 6e 67 20 75 6e 63 | 68 61 6e 67 65 64 2e 0a |eing unc|hanged..|
|000031a0| 0a 54 68 65 20 69 6e 64 | 65 78 20 69 73 20 77 72 |.The ind|ex is wr|
|000031b0| 69 74 74 65 6e 20 74 6f | 20 61 20 66 69 6c 65 20 |itten to| a file |
|000031c0| 63 61 6c 6c 65 64 20 60 | 60 63 78 72 65 66 2e 61 |called `|`cxref.a|
|000031d0| 70 64 78 2e 74 65 78 27 | 27 20 61 6e 64 20 63 78 |pdx.tex'|' and cx|
|000031e0| 72 65 66 2e 74 65 78 20 | 69 73 20 75 70 64 61 74 |ref.tex |is updat|
|000031f0| 65 64 0a 74 6f 20 72 65 | 66 65 72 20 74 6f 20 69 |ed.to re|fer to i|
|00003200| 74 2e 0a 0a 41 6c 73 6f | 20 77 72 69 74 74 65 6e |t...Also| written|
|00003210| 20 6f 75 74 20 61 72 65 | 20 74 68 72 65 65 20 5c | out are| three \|
|00003220| 4c 61 54 65 58 20 73 74 | 79 6c 65 20 66 69 6c 65 |LaTeX st|yle file|
|00003230| 73 20 60 60 70 61 67 65 | 2e 73 74 79 27 27 2c 20 |s ``page|.sty'', |
|00003240| 60 60 66 6f 6e 74 73 2e | 73 74 79 27 27 20 61 6e |``fonts.|sty'' an|
|00003250| 64 0a 60 60 63 78 72 65 | 66 2e 73 74 79 27 27 2e |d.``cxre|f.sty''.|
|00003260| 20 20 54 68 65 73 65 20 | 73 65 74 20 75 70 20 74 | These |set up t|
|00003270| 68 65 20 70 61 67 65 20 | 74 6f 20 75 73 65 20 61 |he page |to use a|
|00003280| 20 73 6d 61 6c 6c 65 72 | 20 6d 61 72 67 69 6e 20 | smaller| margin |
|00003290| 61 6e 64 20 73 6d 61 6c | 6c 65 72 20 66 6f 6e 74 |and smal|ler font|
|000032a0| 73 20 74 6f 0a 61 6c 6c | 6f 77 20 6d 6f 72 65 20 |s to.all|ow more |
|000032b0| 74 6f 20 61 70 70 65 61 | 72 20 6f 6e 20 61 20 70 |to appea|r on a p|
|000032c0| 61 67 65 20 61 6e 64 20 | 61 6c 73 6f 20 64 65 66 |age and |also def|
|000032d0| 69 6e 65 20 74 68 65 20 | 6e 65 77 20 63 6f 6d 6d |ine the |new comm|
|000032e0| 61 6e 64 73 20 66 6f 72 | 20 74 79 70 65 73 65 74 |ands for| typeset|
|000032f0| 74 69 6e 67 0a 74 68 65 | 20 63 78 72 65 66 20 6f |ting.the| cxref o|
|00003300| 75 74 70 75 74 2e 0a 0a | 7b 5c 69 74 20 28 54 68 |utput...|{\it (Th|
|00003310| 65 20 66 69 6c 65 20 6e | 61 6d 65 73 20 60 60 63 |e file n|ames ``c|
|00003320| 78 72 65 66 2e 74 65 78 | 27 27 20 61 6e 64 20 60 |xref.tex|'' and `|
|00003330| 60 63 78 72 65 66 2e 61 | 70 64 78 2e 74 65 78 27 |`cxref.a|pdx.tex'|
|00003340| 27 20 61 72 65 20 64 69 | 66 66 65 72 65 6e 74 20 |' are di|fferent |
|00003350| 69 66 20 74 68 65 20 60 | 60 2d 4e 27 27 0a 6f 70 |if the `|`-N''.op|
|00003360| 74 69 6f 6e 20 69 73 20 | 75 73 65 64 2e 29 7d 0a |tion is |used.)}.|
|00003370| 0a 5c 73 65 63 74 69 6f | 6e 7b 48 54 4d 4c 20 4f |.\sectio|n{HTML O|
|00003380| 75 74 70 75 74 7d 0a 0a | 54 68 65 20 64 65 66 61 |utput}..|The defa|
|00003390| 75 6c 74 20 48 54 4d 4c | 20 6f 75 74 70 75 74 20 |ult HTML| output |
|000033a0| 69 73 20 61 20 66 69 6c | 65 20 66 6f 72 20 65 61 |is a fil|e for ea|
|000033b0| 63 68 20 6f 66 20 74 68 | 65 20 73 6f 75 72 63 65 |ch of th|e source|
|000033c0| 20 66 69 6c 65 73 20 77 | 69 74 68 20 6f 6e 65 20 | files w|ith one |
|000033d0| 65 78 74 72 61 0a 66 69 | 6c 65 20 60 60 63 78 72 |extra.fi|le ``cxr|
|000033e0| 65 66 2e 68 74 6d 6c 27 | 27 20 74 68 61 74 20 69 |ef.html'|' that i|
|000033f0| 6e 63 6c 75 64 65 73 20 | 65 61 63 68 20 6f 66 20 |ncludes |each of |
|00003400| 74 68 65 20 6f 74 68 65 | 72 20 66 69 6c 65 73 2e |the othe|r files.|
|00003410| 20 20 54 68 69 73 20 69 | 73 20 74 6f 20 61 6c 6c | This i|s to all|
|00003420| 6f 77 20 61 0a 6d 61 6b | 65 66 69 6c 65 20 74 6f |ow a.mak|efile to|
|00003430| 20 6f 6e 6c 79 20 75 70 | 64 61 74 65 20 74 68 65 | only up|date the|
|00003440| 20 63 68 61 6e 67 65 64 | 20 66 69 6c 65 73 20 28 | changed| files (|
|00003450| 61 6c 74 68 6f 75 67 68 | 20 74 68 65 20 72 65 66 |although| the ref|
|00003460| 65 72 65 6e 63 65 73 20 | 6d 61 79 20 72 65 71 75 |erences |may requ|
|00003470| 69 72 65 0a 61 6c 6c 20 | 6f 66 20 74 68 65 20 66 |ire.all |of the f|
|00003480| 69 6c 65 73 20 74 6f 20 | 62 65 20 63 68 65 63 6b |iles to |be check|
|00003490| 65 64 20 61 67 61 69 6e | 29 2e 20 20 57 68 65 6e |ed again|). When|
|000034a0| 20 74 68 65 20 63 78 72 | 65 66 2e 68 74 6d 6c 20 | the cxr|ef.html |
|000034b0| 66 69 6c 65 20 68 61 73 | 20 62 65 65 6e 0a 77 72 |file has| been.wr|
|000034c0| 69 74 74 65 6e 20 69 74 | 20 63 61 6e 20 62 65 20 |itten it| can be |
|000034d0| 6d 6f 64 69 66 69 65 64 | 20 62 79 20 74 68 65 20 |modified| by the |
|000034e0| 75 73 65 72 2c 20 61 6e | 79 20 6e 65 77 20 66 69 |user, an|y new fi|
|000034f0| 6c 65 73 20 74 68 61 74 | 20 61 72 65 20 61 64 64 |les that| are add|
|00003500| 65 64 20 61 72 65 20 61 | 64 64 65 64 0a 61 74 20 |ed are a|dded.at |
|00003510| 74 68 65 20 65 6e 64 20 | 62 65 66 6f 72 65 20 74 |the end |before t|
|00003520| 68 65 20 74 61 62 6c 65 | 20 6f 66 20 63 6f 6e 74 |he table| of cont|
|00003530| 65 6e 74 73 2c 20 74 68 | 65 20 72 65 73 74 20 6f |ents, th|e rest o|
|00003540| 66 20 74 68 65 20 66 69 | 6c 65 20 62 65 69 6e 67 |f the fi|le being|
|00003550| 20 75 6e 63 68 61 6e 67 | 65 64 2e 0a 0a 54 68 65 | unchang|ed...The|
|00003560| 20 69 6e 64 65 78 20 69 | 73 20 77 72 69 74 74 65 | index i|s writte|
|00003570| 6e 20 74 6f 20 61 20 66 | 69 6c 65 20 63 61 6c 6c |n to a f|ile call|
|00003580| 65 64 20 60 60 63 78 72 | 65 66 2e 61 70 64 78 2e |ed ``cxr|ef.apdx.|
|00003590| 68 74 6d 6c 27 27 20 61 | 6e 64 20 63 78 72 65 66 |html'' a|nd cxref|
|000035a0| 2e 68 74 6d 6c 20 69 73 | 0a 75 70 64 61 74 65 64 |.html is|.updated|
|000035b0| 20 74 6f 20 72 65 66 65 | 72 20 74 6f 20 69 74 2e | to refe|r to it.|
|000035c0| 0a 0a 7b 5c 69 74 20 28 | 54 68 65 20 66 69 6c 65 |..{\it (|The file|
|000035d0| 20 6e 61 6d 65 73 20 60 | 60 63 78 72 65 66 2e 68 | names `|`cxref.h|
|000035e0| 74 6d 6c 27 27 20 61 6e | 64 20 60 60 63 78 72 65 |tml'' an|d ``cxre|
|000035f0| 66 2e 61 70 64 78 2e 68 | 74 6d 6c 27 27 20 61 72 |f.apdx.h|tml'' ar|
|00003600| 65 20 64 69 66 66 65 72 | 65 6e 74 20 69 66 20 74 |e differ|ent if t|
|00003610| 68 65 20 60 60 2d 4e 27 | 27 0a 6f 70 74 69 6f 6e |he ``-N'|'.option|
|00003620| 20 69 73 20 75 73 65 64 | 2e 29 7d 0a 0a 5c 73 65 | is used|.)}..\se|
|00003630| 63 74 69 6f 6e 7b 45 78 | 61 6d 70 6c 65 20 53 70 |ction{Ex|ample Sp|
|00003640| 65 63 69 61 6c 20 43 6f | 6d 6d 65 6e 74 73 7d 0a |ecial Co|mments}.|
|00003650| 0a 54 68 65 20 66 69 6c | 65 20 60 60 52 45 41 44 |.The fil|e ``READ|
|00003660| 4d 45 2e 63 27 27 20 69 | 73 20 69 6e 63 6c 75 64 |ME.c'' i|s includ|
|00003670| 65 64 20 61 74 20 74 68 | 65 20 65 6e 64 20 6f 66 |ed at th|e end of|
|00003680| 20 74 68 69 73 20 64 6f | 63 75 6d 65 6e 74 20 74 | this do|cument t|
|00003690| 6f 20 73 68 6f 77 20 74 | 68 61 74 20 74 68 65 0a |o show t|hat the.|
|000036a0| 63 6f 6d 6d 65 6e 74 73 | 20 61 72 65 20 69 6e 64 |comments| are ind|
|000036b0| 65 65 64 20 73 65 65 6e | 20 69 6e 20 74 68 65 20 |eed seen| in the |
|000036c0| 63 6f 64 65 2c 20 74 68 | 65 20 72 65 73 75 6c 74 |code, th|e result|
|000036d0| 20 6f 66 20 72 75 6e 6e | 69 6e 67 20 74 68 69 73 | of runn|ing this|
|000036e0| 20 74 68 72 6f 75 67 68 | 20 63 78 72 65 66 0a 69 | through| cxref.i|
|000036f0| 73 20 61 6c 73 6f 20 69 | 6e 63 6c 75 64 65 64 2e |s also i|ncluded.|
|00003700| 0a 0a 5c 73 65 63 74 69 | 6f 6e 7b 46 75 72 74 68 |..\secti|on{Furth|
|00003710| 65 72 20 49 6e 66 6f 72 | 6d 61 74 69 6f 6e 7d 0a |er Infor|mation}.|
|00003720| 0a 54 68 65 72 65 20 69 | 73 20 61 20 6c 69 73 74 |.There i|s a list|
|00003730| 20 6f 66 20 66 72 65 71 | 75 65 6e 74 6c 79 20 61 | of freq|uently a|
|00003740| 73 6b 65 64 20 71 75 65 | 73 74 69 6f 6e 73 20 61 |sked que|stions a|
|00003750| 6e 64 20 74 68 65 69 72 | 20 61 6e 73 77 65 72 73 |nd their| answers|
|00003760| 20 66 6f 72 20 74 68 65 | 20 63 78 72 65 66 0a 70 | for the| cxref.p|
|00003770| 72 6f 67 72 61 6d 20 69 | 6e 20 74 68 65 20 46 41 |rogram i|n the FA|
|00003780| 51 20 66 69 6c 65 2e 20 | 20 41 20 6c 69 73 74 20 |Q file. | A list |
|00003790| 6f 66 20 69 6d 70 72 6f | 76 65 6d 65 6e 74 73 20 |of impro|vements |
|000037a0| 70 6c 61 6e 6e 65 64 20 | 66 6f 72 20 66 75 74 75 |planned |for futu|
|000037b0| 72 65 20 76 65 72 73 69 | 6f 6e 73 20 6f 66 0a 74 |re versi|ons of.t|
|000037c0| 68 65 20 70 72 6f 67 72 | 61 6d 20 61 72 65 20 6c |he progr|am are l|
|000037d0| 69 73 74 65 64 20 69 6e | 20 74 68 65 20 66 69 6c |isted in| the fil|
|000037e0| 65 20 54 4f 44 4f 2e 0a | 0a 4d 6f 72 65 20 75 70 |e TODO..|.More up|
|000037f0| 2d 74 6f 2d 64 61 74 65 | 20 69 6e 66 6f 72 6d 61 |-to-date| informa|
|00003800| 74 69 6f 6e 20 63 61 6e | 20 62 65 20 66 6f 75 6e |tion can| be foun|
|00003810| 64 20 6f 6e 20 74 68 65 | 20 57 6f 72 6c 64 20 57 |d on the| World W|
|00003820| 69 64 65 20 57 65 62 20 | 61 74 20 74 68 65 20 63 |ide Web |at the c|
|00003830| 78 72 65 66 0a 68 6f 6d | 65 70 61 67 65 2c 20 72 |xref.hom|epage, r|
|00003840| 65 61 63 68 65 64 20 76 | 69 61 20 74 68 65 20 61 |eached v|ia the a|
|00003850| 75 74 68 6f 72 27 73 20 | 68 6f 6d 65 70 61 67 65 |uthor's |homepage|
|00003860| 20 68 74 74 70 3a 2f 2f | 77 77 77 2e 67 65 64 61 | http://|www.geda|
|00003870| 6e 6b 65 6e 2e 64 65 6d | 6f 6e 2e 63 6f 2e 75 6b |nken.dem|on.co.uk|
|00003880| 2f 2e 0a 0a 49 66 20 79 | 6f 75 20 77 69 73 68 20 |/...If y|ou wish |
|00003890| 74 6f 20 73 75 62 6d 69 | 74 20 62 75 67 20 72 65 |to submi|t bug re|
|000038a0| 70 6f 72 74 73 20 6f 72 | 20 6f 74 68 65 72 20 63 |ports or| other c|
|000038b0| 6f 6d 6d 65 6e 74 73 20 | 61 62 6f 75 74 20 74 68 |omments |about th|
|000038c0| 65 20 70 72 6f 67 72 61 | 6d 20 74 68 65 6e 20 65 |e progra|m then e|
|000038d0| 6d 61 69 6c 0a 74 68 65 | 20 61 75 74 68 6f 72 20 |mail.the| author |
|000038e0| 61 6d 62 40 67 65 64 61 | 6e 6b 65 6e 2e 64 65 6d |amb@geda|nken.dem|
|000038f0| 6f 6e 2e 63 6f 2e 75 6b | 20 61 6e 64 20 70 75 74 |on.co.uk| and put|
|00003900| 20 63 78 72 65 66 20 69 | 6e 20 74 68 65 20 73 75 | cxref i|n the su|
|00003910| 62 6a 65 63 74 20 6c 69 | 6e 65 2e 0a 0a 5c 73 65 |bject li|ne...\se|
|00003920| 63 74 69 6f 6e 7b 41 75 | 74 68 6f 72 20 61 6e 64 |ction{Au|thor and|
|00003930| 20 43 6f 70 79 72 69 67 | 68 74 7d 0a 0a 54 68 65 | Copyrig|ht}..The|
|00003940| 20 63 78 72 65 66 20 70 | 72 6f 67 72 61 6d 20 77 | cxref p|rogram w|
|00003950| 61 73 20 77 72 69 74 74 | 65 6e 20 62 79 20 41 6e |as writt|en by An|
|00003960| 64 72 65 77 20 4d 2e 20 | 42 69 73 68 6f 70 20 69 |drew M. |Bishop i|
|00003970| 6e 20 31 39 39 35 2c 39 | 36 2e 0a 0a 54 68 65 20 |n 1995,9|6...The |
|00003980| 63 78 72 65 66 20 70 72 | 6f 67 72 61 6d 20 69 73 |cxref pr|ogram is|
|00003990| 20 63 6f 70 79 72 69 67 | 68 74 20 41 6e 64 72 65 | copyrig|ht Andre|
|000039a0| 77 20 4d 2e 20 42 69 73 | 68 6f 70 20 31 39 39 35 |w M. Bis|hop 1995|
|000039b0| 2c 39 36 2e 0a 0a 54 68 | 65 20 63 78 72 65 66 2d |,96...Th|e cxref-|
|000039c0| 63 70 70 20 70 72 6f 67 | 72 61 6d 20 69 73 20 63 |cpp prog|ram is c|
|000039d0| 6f 70 79 72 69 67 68 74 | 20 46 72 65 65 20 53 6f |opyright| Free So|
|000039e0| 66 74 77 61 72 65 20 46 | 6f 75 6e 64 61 74 69 6f |ftware F|oundatio|
|000039f0| 6e 2c 20 49 6e 63 2e 0a | 0a 54 68 65 20 63 78 72 |n, Inc..|.The cxr|
|00003a00| 65 66 20 61 6e 64 20 63 | 78 72 65 66 2d 63 70 70 |ef and c|xref-cpp|
|00003a10| 20 70 72 6f 67 72 61 6d | 73 20 63 61 6e 20 62 65 | program|s can be|
|00003a20| 20 66 72 65 65 6c 79 20 | 64 69 73 74 72 69 62 75 | freely |distribu|
|00003a30| 74 65 64 20 61 63 63 6f | 72 64 69 6e 67 20 74 6f |ted acco|rding to|
|00003a40| 20 74 68 65 0a 74 65 72 | 6d 73 20 6f 66 20 74 68 | the.ter|ms of th|
|00003a50| 65 20 47 4e 55 20 47 65 | 6e 65 72 61 6c 20 50 75 |e GNU Ge|neral Pu|
|00003a60| 62 6c 69 63 20 4c 69 63 | 65 6e 73 65 20 28 73 65 |blic Lic|ense (se|
|00003a70| 65 20 74 68 65 20 66 69 | 6c 65 20 60 43 4f 50 59 |e the fi|le `COPY|
|00003a80| 49 4e 47 27 29 2e 0a 0a | 5c 63 68 61 70 74 65 72 |ING')...|\chapter|
|00003a90| 7b 45 78 61 6d 70 6c 65 | 20 60 60 52 45 41 44 4d |{Example| ``READM|
|00003aa0| 45 2e 63 27 27 7d 0a 0a | 25 20 57 68 61 74 20 61 |E.c''}..|% What a|
|00003ab0| 20 68 61 63 6b 20 74 6f | 20 6c 6f 61 64 20 61 20 | hack to| load a |
|00003ac0| 66 69 6c 65 20 69 6e 74 | 6f 20 61 20 76 65 72 62 |file int|o a verb|
|00003ad0| 61 74 69 6d 20 73 65 63 | 74 69 6f 6e 21 0a 25 20 |atim sec|tion!.% |
|00003ae0| 49 20 68 61 76 65 20 61 | 6c 73 6f 20 68 61 64 20 |I have a|lso had |
|00003af0| 74 6f 20 72 65 6e 61 6d | 65 20 52 45 41 44 4d 45 |to renam|e README|
|00003b00| 2e 63 2e 74 65 78 20 74 | 6f 20 52 45 41 44 4d 45 |.c.tex t|o README|
|00003b10| 5f 63 2e 74 65 78 0a 25 | 20 73 6f 20 74 68 61 74 |_c.tex.%| so that|
|00003b20| 20 5c 69 6e 70 75 74 7b | 52 45 41 44 4d 45 2e 63 | \input{|README.c|
|00003b30| 7d 20 64 6f 65 73 20 6e | 6f 74 20 64 6f 20 5c 69 |} does n|ot do \i|
|00003b40| 6e 70 75 74 7b 52 45 41 | 44 4d 45 2e 63 2e 74 65 |nput{REA|DME.c.te|
|00003b50| 78 7d 20 69 6e 73 74 65 | 61 64 2e 0a 0a 5c 64 65 |x} inste|ad...\de|
|00003b60| 66 5c 65 6e 64 76 65 72 | 62 61 74 69 6d 7b 5c 69 |f\endver|batim{\i|
|00003b70| 6e 70 75 74 7b 52 45 41 | 44 4d 45 2e 63 7d 5c 65 |nput{REA|DME.c}\e|
|00003b80| 6e 64 74 72 69 76 6c 69 | 73 74 7d 0a 5c 62 65 67 |ndtrivli|st}.\beg|
|00003b90| 69 6e 7b 76 65 72 62 61 | 74 69 6d 7d 0a 5c 65 6e |in{verba|tim}.\en|
|00003ba0| 64 7b 76 65 72 62 61 74 | 69 6d 7d 0a 0a 5c 63 68 |d{verbat|im}..\ch|
|00003bb0| 61 70 74 65 72 7b 43 78 | 72 65 66 20 4f 75 74 70 |apter{Cx|ref Outp|
|00003bc0| 75 74 20 46 6f 72 20 60 | 60 52 45 41 44 4d 45 2e |ut For `|`README.|
|00003bd0| 63 27 27 7d 0a 0a 25 20 | 42 65 67 69 6e 2d 4f 66 |c''}..% |Begin-Of|
|00003be0| 2d 53 6f 75 72 63 65 2d | 46 69 6c 65 73 0a 0a 5c |-Source-|Files..\|
|00003bf0| 69 6e 70 75 74 7b 52 45 | 41 44 4d 45 5f 63 2e 74 |input{RE|ADME_c.t|
|00003c00| 65 78 7d 0a 0a 25 20 45 | 6e 64 2d 4f 66 2d 53 6f |ex}..% E|nd-Of-So|
|00003c10| 75 72 63 65 2d 46 69 6c | 65 73 0a 0a 25 20 41 70 |urce-Fil|es..% Ap|
|00003c20| 70 65 6e 64 69 78 0a 0a | 25 20 43 6f 6e 74 65 6e |pendix..|% Conten|
|00003c30| 74 73 20 28 4f 70 74 69 | 6f 6e 61 6c 2c 20 65 69 |ts (Opti|onal, ei|
|00003c40| 74 68 65 72 20 68 65 72 | 65 20 6f 72 20 61 74 20 |ther her|e or at |
|00003c50| 62 65 67 69 6e 6e 69 6e | 67 29 0a 0a 5c 6d 61 72 |beginnin|g)..\mar|
|00003c60| 6b 62 6f 74 68 7b 43 6f | 6e 74 65 6e 74 73 7d 7b |kboth{Co|ntents}{|
|00003c70| 43 6f 6e 74 65 6e 74 73 | 7d 0a 5c 74 61 62 6c 65 |Contents|}.\table|
|00003c80| 6f 66 63 6f 6e 74 65 6e | 74 73 0a 0a 5c 65 6e 64 |ofconten|ts..\end|
|00003c90| 7b 64 6f 63 75 6d 65 6e | 74 7d 0a |{documen|t}. |
+--------+-------------------------+-------------------------+--------+--------+