./ 755 0 0 0 7442532650 4064 ./bin/ 755 0 0 0 7444752443 4642 ./bin/info 755 0 0 340000 7444752435 5646 l8__PAGEZERO X__TEXT __text__TEXT44D<4__fvmlib_init0__TEXTxpPXp__fvmlib_init1__TEXTyY__cstring__TEXTyBY__constructor__TEXTDD__const__TEXTHH__destructor__TEXT__eh_frame__TEXT__DATA  __data__DATA__bss__DATA׬__common__DATA|8__LINKEDIT07/usr/shlib/libsys_s.B.shlibX44 O .#/H#R/H#aZJg yNJg yNJ8gaxBJCga(aN.aPNV-|xpNq yd n"h n"P`N^NuHV,OHyyHyyHy a @Hy׬/( a@N^NuHV,O/ / &nAd($y2S 2"2f fB`BReR 9//9a$ @# 92S!!p$n&nN^NuNVH<g y JgaPJf///aJop&ֆB (o(" y "p !  y ! Rn$ Іg. І y p, PB"y q,B q,BRfJlj&ֆB (o("҂ y "p Ђ!  y ! Rn$Ԇg* y p, PB"y q,B q,BRfLN^NuHV,OH?<$n&n".BI$. *j . Sު 0o.*0S,. Sܪ l,S(& o,o( j,"H"3L<fRRRoo "3L<g(؀o& ot j, 3L<f`BoR"҅o Ѕ j,"3 g"Ҍ  @$"*Ҫ Jo Jo///a؅ RnRnL/9,aB,N^NuNVn J,g/9,HxHxHnaN^NuHV,O/ $n/ a Jg Jf"Jf#d#h#$l# p$nN^NuHV,OH<0G$yJ`$RJgF/ a XXJg&Jdff/9h/ a. yd!yl$!yp GPJgZJfJgNaJfD$SJg$*(ت &+ F** / aXJg///a8%E /9JaL #`/9/9a N^NuHV,OJ l/9/9a`/9/9a#N^NuHV,O// n&. .$9JlB@D//aB`0BA//a* g/9/a#$.&.N^NuHV,O// n$. .&9JlB@D//ab`*BA//a g/9/a$.&.N^NuHV,OH88$n$. ]IDg $B$&BHka (@/ // aB3 yґ" JgC ЋRSJf J<*n,. JgHyz/ E0NPJgHyz/ NPJf ` `B*<08` ~f/ a$/ aP(BP/ EN$@/ ENHra&@/ / a/ EN 3/gHyy/ aиP/ / aЬ/ a(/ aBA"HJg/1<HsHaМHn/ a`JfZ0.@ @g*0.@ @@f/ a$/ a"//a$@/I%FNJgd/ N `/ aD$@BXA"HJg@/1.HraHn/ aJf0.@ @gRCJ.fRCJ<f/ aXHn/ab(@PJfjBL<|N^NuHV,O//&./a$/a! @PdB(//a!.a$.&.N^NuHV,OH0<(n*n &$/ aRXcJg`RJ4(g 4:(ffB`.$BHja&@/ Ht8/ a"B2J4(gR* L< N^NuHV,O//&.gLJ gDB y Jg8/ y p,/aΐPJf y p, (`R y J,fB$.&.N^NuHV,OH 0$. 9$T(o&p й(#(//9 a^# PHxa $@/.GZN$PJg /N%@`B 9$ y ! R$ 9$ y B L N^NuHV,O/Jf*$<R#/a#//HyzaF$.N^NuHV,OH8 &.(. Jf(/a͎#/aX @#BP/E08N$/9NԀ TPm( yTA*#//9a4#P yJf //a`lpf Hy|)/9E/N//9N`FJfB/9aJ$//9ąHy|)/9E/N//9N/aLN^NuHV,OJg /9aBBN^NuHV,O/". A"A . Stg"  fJg ( fRSQB@Sd $N^NuHV,OH08$.&n (n$nB,B/a^XJgp$/ / /a`BHxB/ab$ l#,B`p$lHja&/ //ag#,/a/aB`./a/ /a& o&@R/ /a^& L N^NuHV,OH><(.,. IB, FB/a$XfB`f/G08N$@/NHrKZN&/Hyy/Hy|+/E/N Jg2/NZ/N$/Hy|5/N/Hyz_a/a Hy|;/aƦ*/a JgBB/<aJ$@X//<Hx/ a\$Єn// aB(@P/HtH/ a ؂ g/ E%FN/aPrfJg/ NXI`$// az F ,R// a(@` #,Jga L<|N^NuHV,O/.aJVIDN^NuHV,OH8 $nB/ av$SX`SJo 2.(f( ؂Jf`>A 08`4BA"HJg$&/18/aPJgRCJ.fBLN^NuHV,OH00&. . fB`f/a$/E08N&@/NG 4m T#4//90a#0P//Hy|=/90a* 90L N^NuNVH>0*.BA"HJgGy|܎Syyyyyy/1L/a//adJg>BJg@tԎEHn/a/2>/aǸ//a&Jfp`RJ>fRCJLfnBL |N^NuHV,O/ $yJ`$RJg*/*aXJg/9< j/(aXPJf $nN^NuHV,OH8<*n(MBHxBB/ Hy|Pa(pf/ a$@XJg/,a( @G Hh a&/,/aHy|p/aƺBJg r,Jgt/ r,/(aƦPJg@Hk/ r,/(a JfB r, h 0-f23IAb0g -f //aR(@PJgB` RJ,fz/an/ aPrfB`HxEZN&@BB$/-a(r.Ҁ/N&/-Hy|{/aŠl"l BR 0 f/E08NЬ'@R/a'@ /Hyz_/aT/N",/Ы /Ԭ /a2PO./a`4/.aXrgrg`/9a` /9aN^NuHV,O/$.af 9DTHm$p йH#H//9@a#@ 9D y@! RD 9D y@B $.N^NuHV,OH<8IBBJg JDgB y&PJgxBl` k$p,BDlF y@ p f, Tnp ڀ // aD(@P) <RB<` RDmRmR y&pLJfBDlPBo$ y@ pLg y@Ro 0L,fJgJ,f y@/0LaXRDm/9@a#@#H#DL$@ n /(a$PJhfB`.B ydJgRJ f yd p hR%HԪ%B 9hTlm$p йl#l//9da#d 9h yd! Rh 9h ydB $.$nN^NuHV,O/.a/aN^NuHV,OH8<(nGJfB``J\g/9\alXJ`g/9`aVXB\B`JdgJB ydJg0E%F yd pL/N yd/0LNPR ydJLfBh ydBJPgB lP$PJgKZ/*Hy|aaPrg\/*/aL&PgJ/N#\/*N#`/a $ g//a// a&@/ahXR lP$pLJf~BJg,Jg( sLJf/a sL!@XRJgJLf L<N^NuHV,OB/. /.aN^NuHV,OH80&.(. &nBTJXg/9XaXBX/a$@XJ\g//9\ajPJg*/9PaLHy|a/ a#P JPfHy|a`JgJg/ a$@X`/9PHy|/a߈$@&9N JfBHx/a>`JfR/ aXJ\g@J`g8/9`/9\aJ$/ag//a@//aha`HJlB yPJg RJ f`p#T$9T#XB//a&TfBTL N^NuHV,OH0 &. g/.a\$@XJ\g//9\aPJg/9Pa / a#PPJPgB`Rpl yPJ,g p,//aPJfJm yPJ,fNB`RrlB yPJ,g p,//a]Prgpl yPJ,g p,//a]Jm yPJ,fB`pL N^NuHV,OH<8(nJXfHy} a`JPfHy}*a`4|J l4|B$ ԹT`Ԋpl$ yPJ,g p,//9XaPJfJm yPJ,f`$ ԹT`ԊrlN yPJ,g p,//9Xa\Prgpl" yPJ,g p,//9Xa\(PJm yPJ,f,/9X <yJTo <}#Y#o######0 #]#####&N^NuHV,OH?<$.*n /a* EHhaX(@/// a~B4XG.<Yl0 XA Ѐ 5f/5/ a`LA $ԂJ(gNP`HysaʊXx$E͂/2(a>XJg 2(` <y/a / Az/0/ Hya:R CvJf JgHyzdaXJg / aXHya R/Hyz_aaZ @#  #/( ar/9/9a ypLN^NuHV,O/ / G/9a<$@XJf&B yJJg l ( &H PJfBJgBJg yJJg ` r mp/a6XJfJp l#N/9a\$@X`Z/9NaH/9/9Na:$yN `0Ng/9NaH#NX/9/9NaP/*/ aH $n&nN^NuHV,Oa @Jg#Np4` /9aN^NuHV,O/ / $yJJgpJgd jJg\Hy~ j/a0.a2PJf` <B`x <F`p <J`h@Ab0gr Ё/HyNHyan`0Bt gtg ` <S` <W`AB9 <$.N^NuHV,O"nABJg // a <N^NuHV,OH8$n(n JRgP/9RG08N//9R/ aHJf* L[\]^_/9R`JVgP/9VG08N//9V/ aJf* L`abcd/9V`JZgP/9ZG08N//9Z/ aJf* Lefghi/9Z`LJ^gJ/9^G08N//9^/ a@Jf$ Ljklm/9^`JfgJ/9fG08N//9f/ aJf$ Lnopq/9f`JjgJ/9jG08N//9j/ aJf$ LWXYZ/9j`VJBgD/9BG08N//9B/ aJJf Lrst/9B` JFgP/9FG08N//9F/ aJf* Luvwxy/9F`JNgN/9NG08N//9N/ aJf( Lz{|}~/9N`ZJJgZ/9JG08N//9J/ aPJf4 L/9JNX`I/ah// a Jg"Hyzb/ a/ aHt/ aZLN^NuHV,O//$.&. /a"B` CJgf `RJf SfB$.&.N^NuNVH?<*n/ a`-@XJpg/9paTX nHha#pGB(XJg&R 5\HfBBB 5%8fR 5-8fR58IIb4gE8/ a6-@XI4g LR58I0f 5.8fF58IIb4g2RE8/ a-@XI4g LR58I0f$CHja.,/ HuH/aRshB2h`&R 5[8fIB$/Hs йp/aނ&CR( 3IAb 0f 3-fL5I0g>EH/ a&(@X -fR5HIAb"H0gR5HI1f&DJ3g 3]gRJ5Hg 5]Hf S"/a<$@$/Hs/ a\B2(Hy/ aJf <J g <` /aL&/ aPJfaJgfHy/9Àa$PgHy/aP`BJg4$@Hja*/ //a/ HyHrXa.`BJg//9ÀaBP$`BJf$</G08N$@XJg /NXG`&J/ a$(@BXJg"// E/NHyzb/ N/a,// aPJgc&nd&n Ћc @R-HHh/9pa#pPJg/ /޹p/aJ `/ ޹p/aP/9pa./ a&DPJ3gRJg /a~XRJ5HfFHs޹p/a4 9pL yF`6 yR`. yV`& yZ` y^` yj` yf`AʩJf B`Z c"JRJl`JfT` Jl c` c b cBpL PJf$0.@ @fHx/ arlPJf `0RCJ,f/ avZXHn/a&@PJfBL ,.EBBp-@CBBBBBBBBB$Ar†p㨁,/ BB/ FHhazJnroZB l $// a$@PmB28HxHr8/ay JmրB28JfzJgJgJf / aqlE L|N^NuHV,O/ / np# B#r#EG`R" JgHy/3aPrgrfB`@#$@`RC Uo y 2 f 0 g 0 g" <$n&nN^NuHV,OH?$@/* ah L<Jg&T`Jg&yJJf$$9N#NBaz&@#NXJf&Lp4Bav$@/9/ aF/ / aD./ a#NLN^NuHV,OH8 &.Ba*$/a(/ai/Hy/a$@&9NJfBB/ac/a`PJg,// aPJf/ Hya` //a4P/ ai/aPJfaLN^NuHV,OH8 $.(. BB/aBPJxg$9xJ|g(9|Jf$<y/aXJg /axX/aH&Xf J,g/9,/a`#B`\//a`$PfJJgHy}/ayrPJf2/Hy}EDN$Pf/HyN$Pf /HyN$ LN^NuHV,OH 0$.&n EJfB`JDf / aXJf$<}Hy/arPJf:Hxa$@$BHya%@%kD %kHBB`&+[g // a`JPg // a $@ L N^NuHV,OHx/.aN^NuHV,OHx/.a^N^NuNVH08&n&. JgB y$PJgI0// NPJg0/*/ NPJg" /g/*a// N Jf/ a/aPJf*[fHn/*aq*Prg~A .԰f ".ನg / a X`<(nB-lDB-lHp-@KZ`(B-D .Є/aѮ$n/ HyGАN& pf"/ HyNN&PpVI,DpgHr8avրB$ ԃ/a$CHxN&@HjN'@/ //am kB2'D JgB `2 .Ю-@B .-@p-@Hnah'@ X& TTmpdЬT)@T//,Pa)@PP lP!\R lPB\Hna((XpfL<|N^NuHV,O"n ) Q`Rl 0 g 0f萩N^NuHV,OH<<&.B/. a 8(@/ aPrg|)@ T/aѬp ѬSX`8B)@RJf/ Hy8a PJf"Ҭ/HyEАN$Ppf"Ҭ/HyNN$PpgzHxa*@լ$T/ a GPJg gRJ3g 3f 3f$ R/av+@/ / /ak mB3Hr(a\+@Jfr+A `B C* TTm pdШT!@T//(Pa@"C#@PP"C iP!LR iPBL/ Hyzda Prf/ a`L<<(.$n KBB/./a0*ڪ(RPc,<Z/ Hy|)a $@PpglHx FN&@/ "FN&Hj/ /aj SB0Hra['@ Tnp ր // aR*@P+,RB,  fb~JgX D-hDB-hHp-@Hna H*XrfB D/(ab$@/ a @PdB(/ ai$BXJgRJ<f "@Hia D!@LBXJgH&BT u</aiHsad$ u<// HyS/ai"D iL!<RJ<f"D iLB</ a^TBX$D jP"PJgBJg" U")mRJ<g u<$ilJf@Jg,E%F u</N/5<N"D iL/0<N RJ<f$DBL/a`^$D jL"< u<"(۩R jP"p Jflp DXBJgE%F u</N/5<NPRJ<f/ a]xL<|N^NuHV,OH 0$n&n B jPJg:"H q, hgRJ,f jPJ,g Sk jP p J gJlB`H jP&p /+/ aB"@Jg, jP p, (U#@e )S#@i L N^NuNVH<*n(n JPf`/ a\`vE mP&PJgf/+/ agDPJfBB/aR(@PJg>JDf/ aNXJDg&Hxa$@$B%k ,DЫ%@ BBX-[gp%@-[g p%@%m,[gpp fx"< A n"+ ,H n @/// a JgD'@ ,DЬH-j B-@BHna'@ %@`0J f/ a[`/ / a$@`/* aѪ %k  `R mP&pJfBL<N^NuHV,OHx\a @BBBDBPBLBTBXN^NuHV,O//&.BJg yJg RJgJ,f Tm$p й#//9a# y!, yB,$.&.N^NuHV,OH00&.JgB y$PJgG0//NPJg/*/NPJfP/G%FN/*NPJDg/*DNX/ aF` y!,,R yJ,f yB,`R y$p,JfL N^NuHV,O/ /$nJPg4B jP g/alXR jP 0,f/*PaYBPBTXJLg4B jLJg jL/0,aY^XR jLJ,f/*LaYFBL$.$nN^NuHV,O/ / &n/+E%FN/ N$n&nN^NuNV/ $n*[f,pXHnHjHjH/*a%@DJgpX$nN^NuNVH? $n,. ..-j B-GB n g plWHna(Xpgx/* aXJgh*ڮڀ/Hya$PpgH&ւ/aրB/a$/*acf///*ac Jf%E `X * -@B܇-FBHn/*ar(PpfB`* Ю%@ /afѪ *gp ЮLN^NuHV,OH8$.&. (.HxaL @ !C!DB LN^NuHV,O/ $n/*/*/a @!j $nN^NuHV,O . n "(o //a` //aN^NuHV,OH <(n*n G/ aa$X-gJ/ a>&@AXo6Cb0I1g`0I1g Rn$U"UR`dAo8IIgJg(`Ro0I0IgJg 0IgJ0fJg/ aV4-g `R bJg/ aVpL<N^NuHV,OH0<$n&. K/ a`(@Hla&@B" SPJg(RSJ2(fB3( C(gH/ a *@BXo6Ab5I0g`5I0g Rn C$PS"P`rBo:IIgJg*` Ro JI3IgJg 5IgJ3f*/ G%FNXJg/ N C(g CR` S Ќe/ E%FNXJg/ NpL< N^NuNV n BJg  gRJ0g 0 f-HB-@p-@Hn/.arN^NuHV,O/ $n / /.a(WID$nN^NuHV,O nBJg"  g  fRJg 0 g 0 gN^NuHV,O nBJg0  g  g  fRJg 0 g 0 g 0 gN^NuHV,O nBJg"  g  gRJg 0 g 0 fN^NuHV,OH8 n&. BBCJg .gJg (fRRRJg0IgJgx(fR`dx)f^S`Zx gbx,g\xgVJfx gLJg 0)f x g:x.g4x.f 0 g& 0 g 0 g 0)gRJg0IfLN^NuHV,O"n Q") )SoX )S 0 f 0f 0 g0 0 f 0 g 0f 0 g 0 f 0 f `RnpN^NuHV,O n  WIr€ R 0gB` 0 fR R 0 WIN^NuHV,O nBJgJg  gRJgJ0g 0 f 0 fRN^NuNV/ n-P-h-hp-@`2-B .Ђ/aTѮHnHy,a( Jg `Hna$Xpf$.N^NuNVH 0&n$n / a\H$-R-j-jBX`-J .Ю/aѮ".Ү/HyaV rg`Ѯ .Ю/aѮB".Ү/a< f."n n0f// Ю/a[ Jf `Hna$@XrfTpL N^NuHV,OH< *.$n BBJg/2L/ab$PgJfHx/a&9NP`BB yJJg l ( & PJfJf*/9Jad/9aaBa #N/aqJ&XgHxas//a`&/9JadT/9aPaBa RJLf&ahLtX`:/ a>.HywE{$NPJ|fJxf/+Hy}NPHyam/ Hya f JfB`(/a8HyamvHx0Hx/ aJf/+aXJfL N^NuHV,O//&.$. .Jl"B@D//a,`B/aSPJgJg$.&.N^NuHV,O//&.$. .Jl"B@D//a`B/aSPJgJg$.&.N^NuHV,O n . "."nJl/ BAD//ah`^J(o ( й(`.Jf"rf ( UШ 0o/ /a` Ш 0m (0U m //aN^NuHV,O n . "."nJl/ BAD//aH`XJ(o ( (`4Jf$rf ( T j J f/ /a`"( JlB//aN^NuHV,O/9B.//. /.aN^NuHV,O". .Jg#(/9B@//.aN^NuHV,OHxB.//. /.arN^NuHV,O". .Jg#(HxB@//.a>N^NuHV,O/9B.//. /.aN^NuHV,O". .Jg#(/9B@//.atN^NuHV,OHxB.//. /.aRN^NuHV,O". .Jg#(HxB@//.aN^NuHV,O nB$B p4N^NuHV,O n"h"iS!I$/alN^NuHV,O n . ".JlBAD//a*` Ш 0m (0U m //a0N^NuHV,O n . ".JlBAD//a`"( lB//aN^NuHV,O"n". .JlB@D// aZ`P yB ( R jRJg#,J,o 9,Щ 0m )0U m // arN^NuHV,O"n". .JlB@D// ab`F yB ( R jRJg#,J,o 9,") lB// aN^NuHV,O/ $n . ".JlBAD// a`~ yJJfJ4f/9a`^Srg2"9F"y4 yJJg$R`gJf$H`$AQB@SdNgJ8g/ a~Jp4#N$nN^NuHV,OH0 $n". .JlB@D// a*` yJJfJ4f/9a`nSpgB$9F yJ&94gfJf g"@ f$I` f$B`$jQBASdеNgJ8g/ a}p4#NL N^NuHV,OH08(n$9N#N/,aYB&@#NXJf/9ab`/ a./+aPJgB y$PJgBlj j/0,aXJfN j p,Jg (` j p,  j p,/(/aDPJg// a\&9 SP`RmR y$p<Jf~'l J0g Ba[`/ a`./ a(L N^NuHV,O"n yJJf/9a\`F)7gHy3aF`0/ a0XJ8g/9Na{XJ0gBaZzN^NuHV,O/ $n yJJg**7f"/ a|/ a\PJ4g/ aj*$nN^NuHV,OH< $n(* $**ڪ B yJ` PJgg(7fJg/a|RX`Jg"* * ///aNp4L`$l LN^NuHV,OH<0&n$n B$*f k$(f$g /ai$XJg/*`Hy}ai&./aX*PfJg/9ai(XJgL//*a>PJf:Hy}/a*PfJJgJg /a3X/9aiH(XJf Jg /axX`//9afPJg /a3XJg /a3XJg /a3XJg// HxaL $nN^NuHV,OH8 (.$. /aX"@BXJgnJPghpJgrf JftBJg0 iPJg $H rJ gS RJg iPJfJo"RJo iP p/(/a&PJfHysan`//HxaLN^NuHV,OH8 (.$. /a"@BXJftJgZJPgTpBJg0 iPJg $H rJ gS RJg iPJfJo"RJo iP p/(/a4&PJfHysa`//HxaFLN^NuHV,OHx0Hx/.aN^NuHV,OH 0&n./+a$@XJf/9a``dpԀfBJg$RJf`BJg Sg RJgfJg/2/ a`/HyaXO.aL N^NuNVH><&n,.K/+ FN*Xf( {~f/9a`/9a`I/ aX$@Xpg k-h k, p-H k,Jg p-H` k-hB {~fJgjSHnaj`V k(gHn/a(@P`< `tԎ/&<|> CN(@XJf$Jo k, p-H/ CN(@XJgHy T/a8PJf {fE {f2p`RJg t"+$ mor lSrg$@Hxab*@ t/$<Z BN* t+h t+hPJg/- BN+@XJg/-ab+@X/ aXJgJg/a8@rҀ/ab$@P`Hxab$@X {~fJg /Hy`Hy` Jg/Hy/ a7 `Hy/ a7nP// / aX(@/ E%FN&yNJf"Jg/ NX/adBB/ a&`zJf$/ a,XJgN`Jg^/aa(@XJg4Jg// a7$PJf$M`\x k&(BJg< E$PJg4// a=^PJf +$jDo&(RJg E$p,JfEpg E$pLJfJg/ HyaP`d$+/ / a2P {fLgF"kJ)m$@/ a-$S Jo^ 2.(fPHxHyz& ւ/G0DN Jg*HxHyz/N Jg2(IAb0gB2(`SJn L N^NuHV,OH<8(n*< l&(f&/aD(/E08N&@/NHsaV$///a,// a@$@ .a!XJfa `F&DJg&JB/a$PfHy}/9abP/ // a/ E%FN/NLrҀ/aV$/ HyHyT/a+//a.a!X/ a!XJfaOL N^NuHV,O/.Hy}ajN^NuHV,O/.HyJaRN^NuHV,OH>8IBB yN h/(aV,/a+r(Ҁ/aUT*/HyS/a*B y$PJg`HxaU&&@ R h/(aU&BBP Tnp ր // aU(@P),RB,R y$pLJf/ //.aK($@/G%FN/ ayJg Jf/ N$F`/a L|N^NuHV,OH0<*n$n JfBB/ a`B`R y(p,Jg& , l p /(/ a*(PJfһfJf Jg/ Hyda`LaN"`Bp f y PfHyza` ,l l!  RmS ,S)@l yJ,g&p,` y&P +Sg$`Jo$+S`$+HxaSl"@ k$p, k &0, k$0,"#j#j#j #j#j#j$I/ /aC+C$+B / /aҌ`" , l$p l %p / /aCPJfaLJ8g/ actL< N^NuHV,O yN h/(/.a N^NuHV,O/$./a//a$.N^NuHV,O/ /$.Hy/a<$$@PJfBHx/9Na`lJgZHy/ ajPJf*Jg/9aX`$/ HyaP`//Hxab / aXJfaK$.$nN^NuHV,OH< *.$n $.(.Hy5/a'PJf&<`Hyy/a&PJf/HyaN`FaNBJg///2,/aFRJ,f g /aXHyaLfHyyR/ al$`Hyy/ a $vPJf/ Hya~`F/aZ/Hya}//a4Jg /a `/a.a}LN^NuHV,O n/. /(Hx/( aDN^NuHV,O"nJg iJg/(` iJfB` i/axN^NuNVH 0&n .$n".-k -@-kBJfp-@Jl BpJlp`TJːgpHn/.a$Ppg,Jg(/ a:Xg / / a=P%B$/ aAH L N^NuHV,OH< *.(./. aM\$@/ a"$P`SJg@ 2 (g 2 (g 2,(fJg$B2(BHxB/// a&pg/ a LJ4fJg/9az`/*/as./9az`hJl-j /.// /.//.arg// aPJ4faDB` /a/*/ a R JfpL8(n ,<Jl,<BEGBJgB4Hp gm&p gp g `$<zb`"$<`$<`B4H/a~$X/aAXbpdڀ// aD&@P/Hra/a RJ4Hfv/aHraD$P f <y// <yJg </Hy/a/Hyz_a>Jg / apX/af/9Na*~L|N^NuNVH?0&nBJ lp-@`~-GBBHn/ a=^BˤPJ˨fp2#˨Hx2aC#ˠX"yˠ yˤB0/./9ˠ/.a@~#ː BBaJfJ(g/ a#/9Na)PaHn/ a

/ a." X lЪ jB m * Sg Ъ // a$$.$nN^NuHV,ON^NuHV,ON^NuHV,O///.at&XJ4f/Hyah` J"g| y"JgrHxHxa6$PJ"gHy,Hx/9"a> Hya~Hy/9 a| Jf HxaX/Hxa$.N^NuHV,O". . J g// y N`,Jg$Hy,Hx///9a;vPO.a>N^NuHV,O .Jg / yN`/Hyz_aN^NuHV,O". . Jg// yN`JgHy/Hx/a N^NuHV,OJg yN`JgHy,Hx/9a=xN^NuHV,OJg yN`JgHy,Hx/9a=@N^NuHV,OJg yN`J>gHy,Hx/9>a=N^NuHV,OJg yN`JBgHy,Hx/9Ba$.&.N^NuHV,O// .$. JlB&9/BaPJ&g(Hy,//B/9&a8^PO.a; `*Spg"Hy,//9.a: QBBSdHya$.&.N^NuHV,OH8&.(. $.J>gVJgRJ"g/// y"N`:Jo//a//aJlD//af//aLN^NuHV,O .Jg / yN`/aN^NuNVJg yN`BBHn/<@thB9&/a JfB0.#B0.#Jn>Hy aXXJg/a#XJnHy(a4#XJnBJBNBFBBBVBRB^BZBb`HnHy6a4 @#PBJg Hn/<@tB9&/aT rg.H3>`3 >HnHy9EifN#HnHyHnHyQEifN#VPgHnHyTN#ZP`BZJf #4aXHnHyWEifN#>HnHyZN#BHnHy]N#JVID#6HnHy`N#FPf #cFHnHyeEifN#HnHyhN#"HnHykN#6HnHynN#:E.qGiNXJfHytNXJg4|#2g0HnHywEifN#NHnHyzN#R` BNBRHnHy}EifN#BHnHyN#FHnHyN#JHnHyN#N HnHyN#RHnHyN#VHnHyN#ZHnHyN#^ HnHyN#fHnHyN#jHnHyN#ZHnHyN#^ HnHyN#bJfr#.$n&nN^NuNV/ /Jg yN`"a4B9Hy@/<@t/a Jnf 0yD#nHn/<@t|/E'N#(nHn/<t}/NHy8/<@t/N-y8=yBo8BJg,G08/2,N//2,Ht8aJgRJ,fRn L<N^NuHV,OH80&n$y̒/ a(BXoV /gPJgLBJg2Jg./2,a//2,Hs8aJg RJgJ,fRo 3/8gJ38f L N^NuNVH0<$.KIBHn/a$@APlIHl/a&P/ /Hu8aԊ/a"&@JfJgHka$@/ // aB3ԋ/ ar&@/ a/ a-@ ЮRlHl/a&P/ Hu8aR/ ar `(B58 L< N^NuHV,OH0< .g/aX(@`IJg ~fJ,g ,/fHyOa$@XJfa/az @XJg$hHlG08NX$RJg/ NXԀ/a&@XJg/ / aP`BHl/ aT/ E%FN/ a(@/ N`HxaN&tX,` B8R4(Igr/f BB08/a*@XJf^J̊g/ ẙN*@XJg/ E08N&@Ԍ/NHsa&@/ / a// a/ a `:/-E08N&@Ԍ/NHsa&@/-/ a// ab/ E%FN/ a(@/ N a6/a L< N^NuHV,OH8/.HyZaZ(@PJgx/E08N&@/,NHsa $@ J g/, l  l /0 /Hy,`/, l//Hyn/ a.Hyz_a/ aLN^NuNVH<8*.$. /Hy{a&@PJgJ fJfpg&` k&//HytԎ/a//9Na$@Jfa/ a?rXJg/ a k X` k `IBBB k JgZHxa$@ k /0<a^$BBP Tnp ؀ // a(@P),RB,R k J<f k  k /0 /HytԎ/a/ //a$@/ a>6 J4faTJfBB/9Naނ`DJf / aL`6B`R k J<g&/ k /0<aPJf k J<g k L<*nIBBB,B0&mJgEBBl$ ԫ Tnpdڀ // a (@P)<RB<JgRBB`R-7g8Bl k 2 g Rl k 2 f k 2 fPR`L yB h(R`: k 2//aDЄPdR(`p gp gp fzRBm4+L,+C0L<|N^NuHV,O/ $nJ,g /*,aX/ a$nN^NuHV,O/"nBJg i"( 0l i, 0,$nR0mS m" ) Slt 9V lD l ) Vm#@ `>" ) Sl") ҹV  l#A ` ) S jR—#B J lB p4$N^NuHV,O/ /$nBp l$ * 0l" j,"j 0 $n$"`R0l j,"j 0 $o S$$_N^NuHV,O npJgpf /a` (N^NuHV,OH80&n/ a^$Xlp`< k,$p, k (+$BBo/2(I/a*րPRn L N^NuHV,OH8 $n(. BB`&R 2 (g/2(I/aЃPl LN^NuNVH<<*n-7fv -0 J fL n$yyyy`y}y}y}y}`h n"yyyy`@-@ -@$0" Uk(3IAb` Sk3I0f 3$fHsaX&X` sVID dgn %g cg` sg(`Hu8aHy]/ yjn/`A$p\R/ a؄$Xl$Hu(a/ / $yjn/ aչn`A 0\R$ Ѓr l"/a^// 9jйn/aצ/9ja#n`>A$0\RHu8a// .9j޹n/ab׹n`aȪ/ aXR FJ0Hf"yj ynB0L $n(9j&9n,9`h "l2$Co$ *"҉ r Љ% % Rn䜂`*$Co"҉ r Љ% % Rn؂lm 9nѹj#nL|N^NuHV,O/ $n 9#n#jB^Hyaɪ#f -f p#bR`( +f BbR`JfgBb`p#b $nN^NuHV,OH?<*n ..BJgJHf,Jfp#// /.aH.p#H J^g y^Jf yno #n 9jo #jpbf yjng 9ng$/ aX` yng #j .o*`R no 9 u -fJ(g#n .g~Hy 9/5 aTPJfVR yjng( 9ng / adX` yjnf #j#n# .f yjng&#` 9 u -fJ(f(Jbfp` 9# Rp`"9BJg u (-WIDRе#^Jg 9 u (-g&JgJ(f(I//aNPJfIBBx&y^`RJg =f$nB`Jf(J(`zRJg< K^//9^/a Jf$ ^/aXf(J(|JgDJf@Jg" 9/5 /Hy#Hy(aŮ/9^aШѹ^`JgL&RJgJg R#`JgX 9 u (-f//HyAHy(a>`*/ 9 u I//HynHy(a/9^a ѹ^# p?`pfx no 9# R`VJg" 9/5 /HyHy(aĞ/9^aϘѹ^# p? G :fdp:`^/9^alѹ^Jg n Jfv`Jg, 9 u (-g y^I//a PJf|JgX 9 u (-f/9^/HyHy(a`*/9^ 9 u I//HyHy(aò#y^RBp?` y^R^I//al"@ y^PJfRJg :fTJg>JfgI//HyHy(a2`I//HyHy(aI#p?` WfP );fFIBBB y^Jg#`V nf0*. (.$nGzB$Jf <9`|B9ܺ`V|%g`JIrҀ|Me |j pNjjjjjjlljjlrjjjl(ljjjjjjjjjjlTjjjljljjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjl jjjjljjjjljjjl E` D``:| l$|cl |dLF0$ | LF0| LF(0SD$Jg$`Il IԀ`RJ`IԀJg |g| f>JfJ$g2Jg 9f <>` 9$/HyܺaDRPO| g`~v`|RRR`$ | LF$ԁ` lpЂ|DЀIfHyܺ/ a <zL |N^NuNVH <$n(nJgIAb0gG I*AG I0fG Ѐ&@ .f&RJIAb0gGRJI0f *fRJ$ L.( &B` I/NXOJfJgPJy>oH y>b>2y>A׊20H tЁ$ LA(&BJo9 I/NXOSKJnL<N^NuHV,O//"nBBBp娆Jl^` n $&N^NuHV,O//"nBBBp娆^Jmpe gp娆 n $&N^NuHV,OH 8&n(n $,gD"+S T$p,Jg"S q (Jo Ђ# Sf Ђ S! Jf ,ѫLN^NuHV,OH80&n$. gaHk/ a +Ы PgaA"P&((g"S( Ѐ$`h Tc6$q q *Jo" q *Jo## Ѐ"T`$ q$q (Jo## Ѐ"R$Ԃ RbJfpdtS "<#<Bcn ЀTc6$q q *Jo" q *Jo## Ѐ"T`$ q$q (Jo## Ѐ"R ЀRbpezE/ / a6/a L N^NuHV,O nBJgJgJgR А @XJf N^NuHV,OH 8"n$n &n(n"$Jg>Jg,Jg& * R! Rc") )Щ d$ Б"@XJf&(LN^NuNVH00&nJ g$k BJg /aHրXJf`/+a4&X'C$/a-@/a-@BBPp-@BJ g&$k Jg8HnHnHn/aJf`HnHnHn/+a/Hna*'@ &'nL N^NuHV,OH0 &.$y`$jJgZJf / aXe涪dJf`< `:B"jc.$j Љ" rd"A` (Ш b$RbBL N^NuNVH8 n&n  &Hyy/E0NPJgHy@/NPJg S zgB`n/a$@RHy@/a< Jf'Z`BHk/ InNHk /aV$@B'@ S zfHn/ N$@ LN^NuNVH 8$n&n (n"nBgp?L,ё`@Jl&p?-@Hn/ a$@".L, -A`tgp?-@B3x`p/e |6 pN"`Bё`B0ё`"ӑ`Hn/ EnNHn/N$@ .L, -@ .x .A! `Hn/ a$@ .B3x`lHn/ EnNHn/N$@ .x .A! `8Hn/ EnNHn/N$@7nt'n`Hn/ a$@7nt`Hn/ al$@'n`Hxa6$Hx// a'B`$+Hx/ /aPO.aN`r-ApeCxA .".pЁ!Rrd``Hn/ a$@'n `JHn/ EnNHn/N$@ .L, -@ .x .A".D! `a LN^NuHV,O n !nBBB B!y#N^NuHV,O/$.Hxa//a$.N^NuHV,O . n !@!@ BBB!y#N^NuHV,O/$.Hxa//a$.N^NuHV,O/ .CJg* Qf$H"Jg /* a ` QCJfa$nN^NuHV,O/.a/aN^NuNVLH< (.*. /a$@XJgHn/ a$PfB`HxHnVa P=n-nZ *Y J&XcBHnHnV/a$btԊ n zfHnR/a$ԮRP В&X-jN`HnNHnHnV/a$cNdHx/HnVa* L<8N^NuHV,OH0<*n&n &-r 刟(OBc@`, U"p,$p )j + S! R UB"4pf),"RbBBc UJ,g!,RRb+AL< N^NuHV,OHyyHyyHy a @/( aN^Nu 4d=jT=dP=^D=X@=R<$P8$J420$V,$D$,$&$ $>($\H$ $2$$$$8 (d.L) )))%F)2-z" ($    __eh_frame__TEXTlocaldirdir/ * Menu: wKill ring is empty*Completions*No completionsNot completeSole completionOne completion: %d completions: %s Building completions...%s[%s] .inf/index-info.infounyabba.Yuncompress.Z.zbunzip2.bz2gunzip.gz.../usr/local/info:/usr/info:/usr/local/lib/info:/usr/lib/info:/usr/local/gnu/info:/usr/local/gnu/lib/info:/usr/gnu/info:/usr/gnu/lib/info:/opt/gnu/info:/usr/share/info:/usr/share/lib/info:/usr/local/share/info:/usr/local/share/lib/info:/usr/gnu/lib/emacs/info:/usr/local/gnu/lib/emacs/info:/usr/local/lib/emacs/info:/usr/local/emacs/info:.:%s%s < %s%s...r%s: %s*Footnotes*---------- Footnotes -----------Footnotes*** Footnotes appearing in the node "%s" *** Footnotes could not be displayedIndexFinding index entries...No indices found.Index entry: No previous index search string.No index entries.more No %sindex entries containing "%s".CAN'T SEE THISFound "%s" in %s. (`\[next-index-match]' tries to find next.)TopScanning indices of "%s"...No available info files have "%s" in their indices."(%s)%s" -- %s *Apropos*Index apropos: * Menu: Nodes whoses indices contain "%s": * %s [%s]: (%s)%s.%s * *Note\%0oinfoindex-searchrestoredribbleversionhelpvi-keysusageshow-optionsraw-escapesoutputsubnodesfilenodedirectoryaproposd:n:f:o:ORsTry --help for more information. -4.1texinfo%s (GNU %s) %s 2002Copyright (C) %s Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. INFOPATH/usr/local/infono index entries found for `%s' %s: Usage: %s [OPTION]... [MENU-ITEM...] Read documentation in Info format. Options: --apropos=SUBJECT look up SUBJECT in all indices of all manuals. --directory=DIR add DIR to INFOPATH. --dribble=FILENAME remember user keystrokes in FILENAME. --file=FILENAME specify Info file to visit. --help display this help and exit. --index-search=STRING go to node pointed by index entry STRING. --node=NODENAME specify nodes in first visited Info file. --output=FILENAME output selected nodes to FILENAME. --raw-escapes don't remove ANSI escapes from man pages. --restore=FILENAME read initial keystrokes from FILENAME. --show-options, --usage go to command-line options node. %s --subnodes recursively output menu items. --vi-keys use vi-like and less-like key bindings. --version display version information and exit. The first non-option argument, if present, is the menu entry to start from; it is searched for in all `dir' files along INFOPATH. If it is not present, info merges all `dir' files and shows the result. Any remaining arguments are treated as the names of menu items relative to the initial node visited. Examples: info show top-level dir menu info emacs start at emacs node from top-level dir info emacs buffers start at buffers node within emacs manual info --show-options emacs start at node with emacs' command line options info -f ./foo.info show file ./foo.info, not searching dir Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. Cannot find node `%s'.Cannot find node `(%s)%s'.Cannot find a window!Point doesn't appear within this window's node!Cannot delete the last window.No menu in this node.No footnotes in this node.No cross references in this node.No `%s' pointer for this node.Unknown Info command `%c'; try `?' for help.Terminal type `%s' is not smart enough to run Info.You are already at the last page of this node.You are already at the first page of this node.Only one window.Resulting window would be too small.Not enough room for a help window, please delete a window.*Info Help*\%-10[search-backward] Search backward for a specified string and select the node in which the previous occurrence is found. \%-10[search] Search forward for a specified string and select the node in which the next occurrence is found. \%-10[goto-node] Move to node specified by name. You may include a filename as well, as in (FILENAME)NODENAME. \%-10[index-search] Search for a specified string in the index entries of this Info file, and select the node referenced by the first entry found. \%-10[last-menu-item] Pick last item in node's menu. \%-10[menu-digit] Pick first ... ninth item in node's menu. Other commands: --------------- \%-10[scroll-backward] Scroll backward 1 line. \%-10[scroll-forward] Scroll forward 1 line. \%-10[end-of-node] Go to the end of this node. \%-10[beginning-of-node] Go to the beginning of this node. \%-10[scroll-backward] Scroll backward a page. \%-10[scroll-forward] Scroll forward a page. Moving within a node: --------------------- \%-10[top-node] Move to the Top node. Equivalent to `\[goto-node] Top'. \%-10[dir-node] Move to the `directory' node. Equivalent to `\[goto-node] (DIR)'. \%-10[select-reference-this-line] Follow the hypertext link under cursor. \%-10[move-to-prev-xref] Skip to previous hypertext link within this node. \%-10[move-to-next-xref] Skip to next hypertext link within this node. \%-10[history-node] Move to the last node seen in this window. \%-10[xref-item] Follow a cross reference. Reads name of reference. \%-10[menu-item] Pick menu item specified by name. Picking a menu item causes another node to be selected. \%-10[up-node] Move "up" from this node. \%-10[prev-node] Move to the "previous" node of this node. \%-10[next-node] Move to the "next" node of this node. Selecting other nodes: ---------------------- \%-10[get-info-help-node] Invoke the Info tutorial. \%-10[quit] Quit Info altogether. \%-10[quit-help] Quit this help. Basic Commands in Info Windows ****************************** %s .. %s (%s) --------------------- The current search path is: %s Commands available in Info windows: Commands available in the echo area: The following commands can only be invoked via %s: The following commands cannot be invoked at all: %s %s %s --- Use `\[history-node]' or `\[kill-node]' to exit --- HelpHelp-Small-ScreenInfoDescribe key: %s%s is undefined.%s (%s): %s.M-%sLFDTABRETESCC-%cSPCDELPgUpPgDnHomeEndINSUpDownLeftRightquit-helphistory-nodedelete-window0123456789-%dN/A%s %sWhere is command: `%s' is not on any keys%s can only be invoked via %s.%s can be invoked via %s.There is no function named `%s'INFOKEYHOMEIgnoring invalid infokey file `%s' - too smallIgnoring invalid infokey file `%s' - too bigError reading infokey file `%s' - short readInvalid infokey file `%s' (bad magic numbers) -- run infokey to update itYour infokey file `%s' is out of date -- run infokey to update itInvalid infokey file `%s' (bad section length) -- run infokey to update itInvalid infokey file `%s' (bad section code) -- run infokey to update itBad data in infokey file -- some key bindings ignoredBad data in infokey file -- some var settings ignoredDescribe command: %s: %s.%d %s %s echo-area-Cannot execute an `echo-area' command here.Set screen height to (%d): *manpages*Up:Node:File: %c %s %s, %s %s, %s (dir) PATHman/dev/nullSEE ALSO SEE ALSO SEE ALSO SEE ALSORELATED INFORMATION RELATED INFORMATION RELATED INFORMATION RELATED INFORMATION( * Menu: (File)Node Lines Size Containing File ---------- ----- ---- ---------------* %s::* (%s)%s::%ld*Node Menu*Here is the menu of nodes you have recently visited. Select one from this menu, or use `\[history-node]' in another window. Select visited node: The reference disappeared! (%s).topTOP* End Tag TableTag Table: (Indirect)Indirect: Ref:%s/%sWelcome to Info version %s. Type \[get-help-window] for help, \[menu-item] for menu item.TERMdumbPage OnlyNext OnlyContinuousNext:NextFollowing Next node...Selecting first menu item...Selecting Next node...Moving Up %d time(s), then Next.No more nodes within this document.Prev:Previous:No `Prev' for this node.Moving Prev in this window.PrevNo `Prev' or `Up' for this node within this document.Moving Up in this window.Moving to `Prev's last menu item.Cannot delete a permanent window(%s)%s*info-parse-and-select*This window has no additional nodesThere aren't %d items in this menu.MenuMenu item (%s): Menu item: Follow xref (%s): Follow xref: (%s)*Goto node: No menu in node `%s'.No menu item `%s' in node `%s'.Unable to find node referenced by `%s' in `%s'.Follow menus: %s cmdlineArgumentsAll optionsInvokingOption Options%s optionsInvoking `%s'Command ArgumentsInvocationPreliminariesInvoking %s%s invocationFind Invocation node of [%s]: Get Manpage: (dir)TopKill node (%s): Cannot kill node `%s'Cannot kill the last nodeFind file: Cannot find `%s'.Could not create output file `%s'.Done.Writing node %s...INFO_PRINT_COMMANDlprCannot open pipe to `%s'.Printing node %s...Searching subfile %s ... case-sensitively Search backwardSearch%s%sfor string [%s]: Search failed.No previous search stringI-search backward: I-search: \n\tFailing %s%s%s* QuitUnknown command (%s)."%s" is invalidsun-cmdCOLUMNScoLINESli pccrceclcmALDLaldlmrmeupdnvbbltitekskekmMTmmmokukdkrklkPkNkh@7kIkD ~ ~OnOffWhen "On", Info accepts and displays ISO Latin charactersISO-LatinThe number lines to scroll when the cursor moves out of the windowscroll-stepControls what happens when scrolling is requested at the end of a nodescroll-behaviourWhen "On", the portion of the matched search string is highlightedshow-index-matchWhen "On", Info garbage collects files which had to be uncompressedgc-compressed-filesWhen "On", errors cause the bell to ringerrors-ring-bellWhen "On", flash the screen instead of ringing the bellvisible-bellWhen "On", creating or deleting a window resizes other windowsautomatic-tilingWhen "On", footnotes appear and disappear automaticallyautomatic-footnotesDescribe variable: %s (%d): %s.Set variable: Set %s to value (%d): Set %s to value (%s): AllBot%2d%%*no file**no node*--*** Tags out of Date ***$-%s---Info: %s, %d lines --%s--zz---%s%s-Info: (%s)%s, %d lines --%s-- Subfile: %s-. +0123456789%Set the value of an Info variableset-variableExplain the use of a variabledescribe-variableShow the footnotes associated with this node in another windowshow-footnotesSelect a node which has been previously visited in a visible windowselect-visited-nodeMake a window containing a menu of all of the currently visited nodeslist-visited-nodesGrovel all known info file's indices for a string and build a menuindex-aproposGo to the next matching index item from the last `\[index-search]' commandnext-index-matchLook up a string in the index for this fileSet the height of the displayed windowset-screen-heightRead a command name in the echo area and execute itexecute-commandRead the name of an Info command and describe itdescribe-commandShow what to type to execute a given commandwhere-isPrint documentation for KEYdescribe-keyVisit Info node `(info)Help'get-info-help-nodeDisplay help messageget-help-windowScroll the completions windowecho-area-scroll-completions-windowInsert completionecho-area-completeList possible completionsecho-area-possible-completionsKill the word preceding the cursorecho-area-backward-kill-wordKill the word following the cursorecho-area-kill-wordKill to the beginning of the lineecho-area-backward-kill-lineKill to the end of the lineecho-area-kill-lineYank back a previous killecho-area-yank-popYank back the contents of the last killecho-area-yankTranspose characters at pointecho-area-transpose-charsInsert a TAB characterecho-area-tab-insertInsert this characterecho-area-insertInsert next character verbatimecho-area-quoted-insertAccept (or force completion of) this lineecho-area-newlineCancel or quit operationecho-area-abortDelete the character behind the cursorecho-area-ruboutDelete the character under the cursorecho-area-deleteecho-area-backward-wordecho-area-forward-wordMove to the end of this lineecho-area-end-of-lineMove to the start of this lineecho-area-beg-of-lineecho-area-backwardecho-area-forwardInternally used by \[universal-argument]numeric-arg-digit-loopStart (or multiply by 4) the current numeric argumentuniversal-argumentAdd this digit to the current numeric argumentadd-digit-to-numeric-argRun command bound to this key's lowercase variantdo-lowercase-versionQuit using InfoquitRedraw the displayredraw-displayMove the cursor to a specific line of the windowmove-to-window-lineCancel current operationabort-keySelect reference or menu item appearing on this lineselect-reference-this-lineMove to the next cross referencemove-to-next-xrefMove to the previous cross referencemove-to-prev-xrefisearch-backwardSearch interactively for a string as you type itisearch-forwardRepeat last search in the reverse directionsearch-previousRepeat last search in the same directionsearch-nextRead a string and search backward for itsearch-backwardRead a string and search for itsearchRead a string and search for it case-sensitivelysearch-case-sensitivelyPipe the contents of this node through INFO_PRINT_COMMANDprint-nodeRead the name of a file and select itview-fileKill this nodekill-nodeSelect the most recently selected nodeSelect the node `(dir)'dir-nodeSelect the node `Top' in this filetop-nodeRead a manpage reference and select itFind the node describing program invocationgoto-invocation-nodeRead a list of menus starting from dir and follow themmenu-sequenceRead a node name and select itgoto-nodeVisit as many menu items at once as possiblevisit-menuMove to the start of this node's menufind-menuRead a footnote or cross reference and select its nodexref-itemRead a menu item and select its nodemenu-itemSelect this menu itemmenu-digitSelect the last item in this node's menulast-menu-itemSelect the first node in this filefirst-nodeSelect the last node in this filelast-nodeSelect the Up nodeup-nodeSelect the Prev nodeprev-nodeSelect the Next nodenext-nodeToggle the state of line wrapping in the current windowtoggle-wrapDivide the available screen space among the visible windowstile-windowsGrow (or shrink) this windowgrow-windowScroll the other window backwardscroll-other-window-backwardScroll the other windowscroll-other-windowDelete all other windowskeep-one-windowDelete the current windowSplit the current windowsplit-windowSelect the previous windowprev-windowSelect the next windownext-windowScroll up by half screen sizescroll-half-screen-upScroll down by half screen sizescroll-half-screen-downScroll up by linesup-lineScroll down by linesdown-lineMove to the end of this nodeend-of-nodeMove to the start of this nodebeginning-of-nodeScroll backward in this window staying within node and set default window sizescroll-backward-page-only-set-windowScroll backward in this window staying within nodescroll-backward-page-onlyScroll backward in this window and set default window sizescroll-backward-set-windowScroll backward in this windowscroll-backwardScroll forward in this window staying within node and set default window sizescroll-forward-page-only-set-windowScroll forward in this window staying within nodescroll-forward-page-onlyScroll forward in this window and set default window sizescroll-forward-set-windowScroll forward in this windowscroll-forwardMove backwards or up through node structureglobal-prev-nodeMove forwards or down through node structureglobal-next-nodeMove backward a wordbackward-wordMove forward a wordforward-wordMove backward a characterbackward-charMove forward a characterforward-charMove to the start of the linebeginning-of-lineMove to the end of the lineend-of-lineMove up to the previous lineprev-lineMove down to the next linenext-linexmallocxrealloc%s: Out of virtual memory! POSIXLY_CORRECT%s: option `%s' is ambiguous %s: option `--%s' doesn't allow an argument %s: option `%c%s' doesn't allow an argument %s: option `%s' requires an argument %s: unrecognized option `--%s' %s: unrecognized option `%c%s' %s: illegal option -- %c %s: invalid option -- %c %s: option requires an argument -- %c %s: option `-W %s' is ambiguous %s: option `-W %s' doesn't allow an argument ferror on stdoutfflush error on stdoutTERMCAP/etc/termcapTermcap entry too long Bad termcap entry Infinite tc= loop E^^\\::n r t bf OOPSeh4l RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR<RRRRRRRjRRR "*2:BJRZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZy+H,,,,,,,,,,,,,,,+H,,+H+H,,,,,,,,ussssstuut2tttfttuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu<uRxDyyzzzzzyzzzzzzzzzz|D~~~~d~n~f~~o~~O~O~~~~~~a^zd;zdy<Ox,zd_0b1zdym ? @ @ A` C=<G ,h/80'1(2(3(4(5(6(7(8(9(<&>%?`[ ]bd2ef*g-G.haigl3m)n"O/p#qDr*s8S7t1u$0F1F2F3F4F5F6F7F8F9F-FlA ><>bfrBvFFFFFFFFFFFlA>BxeejD5A5012^bkk4n:N;ot w!   OA OB OC OD      OA OB OC OD0F1F2F3F4F5F6F7F8F9F-FFFFFFFFFFFFQ_bNd[fMyX?] U\Q_N[MX]U\KJOLIQP (Y CSVGW R R ^ ^?]PoZ IOCII JODJJ MOCMM NODNN P K L \ Z0F1F2F3F4F5F6F7F8F9F-F ?    A  CC< ,h/80'1(2(3(4(5(6(7(8(9('(((((((((<&>%?9[ ]'3bdeE5:e5f F g&G%h`H`igI/jkl3m)n:N;O/p#qDQD:qD:QDZZDrCRCs8S7t1uwyz lA > <>/8?9bd2ef*g@ham)n8N9r=s<t1vxeejD5A5 @ @012^bkg-igI/k4n"oO/p#r*t u$w!,h   OA OB  OC  OD      #OA## "OB"" *OC** OD Z1F2F3F4F5F6F7F8F9F-FFFFFFFFFFFQ\_0K$LbNd[fMhIlJwMxOX[yX?] U[Q\_KLN[MIJMO[X]U[KJOLIQP (Y CSVQSW R R ^ ^?]PoZ IOCII JODJJ K L P MOCMM NODNN [ Z mXND:0Sz_zbzdr~F8̖0̖y:̖h?̖+ˀ̖L̖;/Vt̖ޖ6rz`Bߴ5J r\a5&"iDExrX%(BtWdM80ngVZAz'*k^",.^{YN+Lf.Vb~X2'twK"$\t\|g \\" XymD4*HdmL1n $r m] H$$%.nEE3Ef E EEFGxRHAI" IrIz~ImWJB+J4JK0K{_L*B Lh LPpS]KY ' UFDp2~jrYxzdP k>?t_`5a &   E XtM0Z^ !"#${%N&'()*X+',-.w/"012345\6 789m:4;<=>m?1@ABCmDHEFGnH3I J KLMNxOAP QRSmTBUVWX{YBZ [\]]^'_`abcDdef~gYhijPklmn?@(#)termcap.c 5.1 (Berkeley) 6/5/85@(#)tgoto.c 5.1 (Berkeley) 6/5/85@(#)tputs.c 5.1 (Berkeley) 6/5/855MS7) ./bin/infokey 755 0 0 60000 7444752435 6336 l8__PAGEZERO X__TEXT @@__text__TEXT%'__fvmlib_init0__TEXTMP-__fvmlib_init1__TEXTNd.d__cstring__TEXTNd.d__constructor__TEXT]=__const__TEXT]=__destructor__TEXT_?__eh_frame__TEXT_?__DATA` @ __data__DATA`@__bss__DATAc__common__DATAi08__LINKEDIT`07/usr/shlib/libsys_s.B.shlibX% O .#`/H#`R/H#`aZJg yNJg yNJ8gaBJCgahat.a@PNV-|MNq Ndd n"h n"P`N^NuHV,OHyNdHyNoHy a: @Hyc/( a#vN^NuNVH00$.&n HyNBaPHnHy` /9``/ /a"pglJf .A`(Jf A`,"0Jgpof,J`g/9`aX/9i0a(#`X`azHxa X`pJ`gFHyNHyN/9` HyNE,NHyNaPHyNHyNNBa J`ga(BaX Scf0J`g/9`a6X 9c/3 ap#`X`*cg"HyOBa aHxaR HyOan$@XJ`fHyO/ a^#`PJ`fHyO/ a@#`PHyO/9`ah&Pf&/9`HyO/9a HxaHyc,/9`/a> JgHyO/9`a $@PJf&/9`HyO/9a HxajBHyc,/ a dPJf/9`HyP /9a ~t / aZXrf/9`HyP#/9a Pt Jg/9`aHxaP/aBaL N^NuHV,OH80&.(. /E08N&@/NHsa$//aHyPB/E/N//N L N^NuNVH?<,. BB.BKBB.p n B(!@B(B`B.p ez |] pNRr#f:|`^p gVrd pg `:|BB`:|B|`(B:|r fKA .B0HyPD/aPJfB`HyPIHnaPJf r-A`HyPSHnaPJf p-@`HyPWHnaPJfre .툐 n`rpeh".R`Xp fPK`Hre@ |]: p|Np gAb08g:||JfHyP\`r\f~`p^f~`reA RJ.g``pЃrDe |]N p N~8@|`reA RJ.g ``peA RJ.g ``reA RJ.g ` `pezA RJ.g`z `rreVA RJ.g`V `N|B`~`pe A RJ.g ``HyPq//a x B.`p7m*r0n$R. .n&0 8@ .fB`|B|rg>0 JgFre"A RJ.g 2 `2 `HyPq//ax B.`HyP`peA RJ.g` `HyPq//a:x B.pЃr4e |^b p NpebA RJ.g ```Vre8A RJ.g `6`,peA RJ.g ` `reA RJ.g ``peA RJ.g ``reA RJ.g ``pefA RJ.g`f`^reBA RJ.g`B`:peA RJ.g` `HyPq//ax B.` $n(9i &9i$,9c`h "l2$Co$ *"҉ r Љ% % Rn䜂`*$Co"҉ r Љ% % Rn؂lm 9ci$ѹi #ci$L|N^NuHV,O/ $n 9c#i$#i BiHy[aP#i -f p#iR`( +f BiR`JigBi`p#i $nN^NuHV,OH?<*n ..Bi0JcgJi4f,Jcfp#c// /.aH.p#i4 Jig yiJf yi$co #ci$ 9i co #ci pif yi i$g 9i$cg$/ aX` yi$cg #ci .co*`Rc nco 9c u -fJ(g#ci$ .cg~Hy[ 9c/5 aPJfVRc yi i$g( 9i$cg / adX` yi i$f #ci #i$#c .cf yi i$g&#c` 9c u -fJ(f(Jifp` 9c# i0Rcp`"9cBJg u (-WIDRе#iJg 9c u (-g&JgJ(f(I//aNPJfIBBx&yi`RJg =f$nB`Jf(J(`zRJg< Ki//9i/a Jf$ i/aXf(J(|JgDJf@Jcg" 9c/5 /Hy["Hy(aT/9iaNѹi`JgL&RcJgJg R#i0`JcgX 9c u (-f//Hy[@Hy(a`*/ 9c u I//Hy[mHy(a/9iaѹi# c p?`pfx nco 9c# i0Rc`VJcg" 9c/5 /Hy[Hy(aD/9ia>ѹi# c p? G :fdp:`^/9iaѹiJg n Jfv`Jg, 9c u (-g yiI//a PJf|JcgX 9c u (-f/9i/Hy[Hy(a`*/9i 9c u I//Hy[Hy(aX#NiRcBc p?` yiRiI//al"@ yiPJfRcJg :fTJcg>JigI//Hy\Hy(a`I//Hy\Hy(aI#c p?` WfP );fFIBBB yiJg#i0`V ncfJg,Jg& * R! Rc") )Щ d$ Б"@XJf&(LN^NuNVH00&nJ g$k BJg /aHրXJf`/+a4&X'C$/a-@/a-@BBPp-@BJ g&$k Jg8HnHnHn/aJf`HnHnHn/+a/Hna*'@ &'nL N^NuHV,OH0 &.$yi(`$jJgZJf / aXe涪dJf`< `:B"jc.$j Љ" rd"A` (Ш b$RbBL N^NuNVH8 n&n  &HyN/E0NPJgHy\/NPJg S zgB`n/a$@RHy\/a Jf'Z`BHk/ IBNHk /aV$@B'@ S zfHn/ N$@ LN^NuNVH 8$n&n (n"nBgp?L,ё`@Jl&p?-@Hn/ a$@".L, -A`tgp?-@B3x`p/e |_6 pN"`Bё`B0ё`"ӑ`Hn/ EBNHn/N$@ .L, -@ .x .A! `Hn/ a$@ .B3x`lHn/ EBNHn/N$@ .x .A! `8Hn/ EBNHn/N$@7nt'n`Hn/ a$@7nt`Hn/ al$@'n`Hxaߔ$Hx// aR'B`$+Hx/ /a8PO.a۬`r-ApeCxA .".pЁ!Rrd``Hn/ a$@'n `JHn/ EBNHn/N$@ .L, -@ .x .A".D! `a LN^NuHV,O n !nBBB B!yi(#i(N^NuHV,O/$.Hxar//a$.N^NuHV,O . n !@!@ BBB!yi(#i(N^NuHV,O/$.Hxa//a$.N^NuHV,O/ .Ci(Jg* Qf$H"Jg /* a& ` QCJfa$nN^NuHV,O/.a/aN^NuNVLH< (.*. /a$@XJgHn/ a$PfB`HxHnVahP=n-nZ *Y J&XcBHnHnV/a$btԊ n zfHnR/a$ԮRP В&X-jN`HnNHnHnV/a$cNdHx/HnVaՈ L<8N^NuHV,OH0<*n&n &-r 刟(OBc@`, U"p,$p )j + S! R UB"4pf),"RbBBc UJ,g!,RRb+AL< N^NuHV,OHyNdHyNoHy a @/( aN^Nu &td=jT=dP=^D=X@=R<$P8$J420$V,$D$,$&$ $>($\H$ $2$$$$8 (d.`L`) )))%F)2-z" ($`    __eh_frame__TEXTinfokeyversionhelpoutputo:4.1texinfo%s (GNU %s) %s 1999Copyright (C) %s Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. incorrect number of argumentsHOME.infokey.inforcannot open input file `%s'wcannot create output file `%s'error writing to `%s'error closing output file `%s'/infoecho-areavarstopmissing key sequencekey sequence too longNUL character (\000) not permittedNUL character (^%c) not permittedmissing action namesection too longunknown action `%s'action name too longextra characters following action `%s'missing variable namemissing `=' immediately after variable namevariable name too longvalue too longinvalid%s: - %s "%s", line %u: Try --help for more information. Usage: %s [OPTION]... [INPUT-FILE] Compile infokey source file to infokey file. Reads INPUT-FILE (default $HOME/.infokey) and writes compiled key file to (by default) $HOME/.info. Options: --output FILE output to FILE instead of $HOME/.info --help display this help and exit. --version display version information and exit. Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. set-variabledescribe-variableshow-footnotesselect-visited-nodelist-visited-nodesindex-aproposnext-index-matchindex-searchset-screen-heightexecute-commanddescribe-commandwhere-isdescribe-keyget-info-help-nodeget-help-windowecho-area-scroll-completions-windowecho-area-completeecho-area-possible-completionsecho-area-backward-kill-wordecho-area-kill-wordecho-area-backward-kill-lineecho-area-kill-lineecho-area-yank-popecho-area-yankecho-area-transpose-charsecho-area-tab-insertecho-area-insertecho-area-quoted-insertecho-area-newlineecho-area-abortecho-area-ruboutecho-area-deleteecho-area-backward-wordecho-area-forward-wordecho-area-end-of-lineecho-area-beg-of-lineecho-area-backwardecho-area-forwardnumeric-arg-digit-loopuniversal-argumentadd-digit-to-numeric-argdo-lowercase-versionquitredraw-displaymove-to-window-lineabort-keyselect-reference-this-linemove-to-next-xrefmove-to-prev-xrefisearch-backwardisearch-forwardsearch-previoussearch-nextsearch-backwardsearchsearch-case-sensitivelyprint-nodeview-filekill-nodehistory-nodedir-nodetop-nodemangoto-invocation-nodemenu-sequencegoto-nodevisit-menufind-menuxref-itemmenu-itemmenu-digitlast-menu-itemfirst-nodelast-nodeup-nodeprev-nodenext-nodetoggle-wraptile-windowsgrow-windowscroll-other-window-backwardscroll-other-windowkeep-one-windowdelete-windowsplit-windowprev-windownext-windowscroll-half-screen-upscroll-half-screen-downup-linedown-lineend-of-nodebeginning-of-nodescroll-backward-page-only-set-windowscroll-backward-page-onlyscroll-backward-set-windowscroll-backwardscroll-forward-page-only-set-windowscroll-forward-page-onlyscroll-forward-set-windowscroll-forwardglobal-prev-nodeglobal-next-nodebackward-wordforward-wordbackward-charforward-charbeginning-of-lineend-of-lineprev-linenext-linePOSIXLY_CORRECT--%s: option `%s' is ambiguous %s: option `--%s' doesn't allow an argument %s: option `%c%s' doesn't allow an argument %s: option `%s' requires an argument %s: unrecognized option `--%s' %s: unrecognized option `%c%s' %s: illegal option -- %c %s: invalid option -- %c %s: option requires an argument -- %c %s: option `-W %s' is ambiguous %s: option `-W %s' doesn't allow an argument ferror on stdoutfflush error on stdoutxmallocxrealloc%s: Out of virtual memory! eh&***++00112222F+,*00-p. ,B,B,B,B,B,B,B,B-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.,V-.-.,-.-.-.-.-.-(-.-,-.-.-.,-.,/4///////////////// //////////////.////^///./////.//.b///J>HVH\HfHpHxHJ>J>HI`III0IHJ8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8J8IIILNvNoN`N~`N[ZZZZZZZZZ Zv Z\ ZC Z ZYYYYYYYYmYWYKY?Y2Y$YYXXX X!X"X#X$X%X&X~'Xs(Xi)X_*XU+XJ,X@-X2.X/X0X1X2W3W4W5W6W7W8W9W:W;W<Wo=W]>WK?W0@W&AWBWCVDVEVFVGVHVIVJVkKVULV>MV&NVOVPUQURUSUTUUUVU{WUhXUTYU7ZU#[U\T]T^T_T`TaTbTwcTfdTVeTDfT7gT&hTiTjSkSlSmSn?./bin/makeinfo 755 0 0 400000 7444752436 6502 l8__PAGEZERO X__TEXT __text__TEXT%XD2X__fvmlib_init0__TEXTiPI__fvmlib_init1__TEXTjJ__cstring__TEXTjLSJ__constructor__TEXT00__const__TEXT44__destructor__TEXT__eh_frame__TEXT__DATA`__data__DATAB__bss__DATA__common__DATA048__LINKEDIT@07/usr/shlib/libsys_s.B.shlibX%X O .#/H#R/H#aZJg yNJg yNJ8gaTBJCgaaj.aPNV-|iNq jd n"h n"P`N^NuHV,OHyjHyjHy a @Hy/( a@N^NuHV,OJf /9وaN^NuHV,OJf(JlgJpfHysa` Hx aN^NuHV,OJhgHysa>`:JlgJpfHysa`Jpga%` aa &N^NuHV,OJfPJlgJpfHypNaT`2JpgHysa>` <sJhg <s/aN^NuHV,OJfZJlgJpfHyp7a`JlgJpfHyrax` JpgHysab` Hx*a"N^NuHV,OJf JlgHyna4` Hx-aN^NuHV,OJf*JlgJpfHyla` HysTatN^NuHV,OJfVJhgHysaR`@JlgJpfHyrJa`"JpgHysa` HysaN^NuNVJfBBa-@Hnah @ (l/ (C̨/1 /( HytMaN^NuHV,O .JhgHy4/a5t`Jlg /Hx aN^NuHV,O .JhgHytV/a5<`Jlg /Hx!aN^NuHV,O .Jlg/Hx"a``Jf2R`JhgHyrmBa4`>Jhf6Hx`aB`*JhgHyrm/a4`Jhf Hx'a N^NuHV,O .Jlg/Hx#a`2JhgJfR`Hyn/a4b`J`f/a2N^NuHV,O .Jlg/Hx$a`FJhg JfHytYa@`,Hytda2`JfHytpa ` HytraN^NuHV,O .Jlg/Hx%aV`2Jhg"<tyJf"<tt/a`r>Jfr JlgBBHx3E@FNHnBa/.Hyu`a/.aZHxHx3N`x,9H*9ـxBHBـa&9$JhgHyuaXahHnBaH/.Hyu`aJ/.aaJJhgHyuab`$9$S S"l y "H 0 (fSl 1 (gR#$$B 9ToHja-@/ / 9 Ѓ/a $9T jR$#$XSpgHx aXQBBSdBoB n0(/aXRn/.aXHx a#ـ#HL|N^NuHV,Opf <uJhg <u/a@N^NuHV,Opf <uJhg <u/aN^NuHV,Opf HyuaN^NuHV,Opf HyuaN^NuHV,Opf <vJhg <u/aN^NuHV,Opf Hyv aN^NuNV//$9P&9`HnBaPJPg 9\PB`/9\aXJhgHysa2Xa/.Hyu`a/.at JhgHysaXa#P#`$.&.N^NuNV/ JgJ faqaHnBaXPJgJ f/9٠/9٘aoPa JgRB yJg PRJfЀHyv/HyvE,N/./9وHx@HyvNHya> /.aXJf@aS٤/9aF//./9وHx@Hyvaw /.a:`LJgJ f/9٠/9٘aoPJfa` BaIX/.aab$nN^NuHV,OHxaN^NuHV,OBaN^NuHV,OaZa,#ٜ٠N^NuNVHnHxa/.a Jg/9وHx@Hyv,av0 /.a\N^NuHV,O/ /$.Hyr/E0NPJgVHyr/NPJgFHyvA/NPJgHyvA/NPJfB\`Hy\Hyuc/a"ptfB$.$nN^NuNVHnHxa /.ab Jg/9وHx@Hyv,au^ /.aN^NuHV,O nBBBN^NuHV,O/ $n *ep В$//*a%@ * j! R$nN^NuHV,OH 0&n$SRrJf&p`8If S٤HyvFatR٤S&B`t{fRt}fS`L N^NuNVH0 $nHna6XJg0  g  f,R  g  gHysa/Hna ` @fR$ RI/a}XJgR`Igr{g v gr f "{f-JHna$nX`~ c [g ]f$ R`` {f"-JHna$ R$nX" Jg>S`:$ Ig.v g(p g"pЁvdp[gv]g p{gv@fS" //aT/Hna`BHna .L N^NuHV,OH00&n&. B$[Jg  ft`JgHx aBX c [g ]fI/aX` &f Jhf&`N @f/ Hyu`aBP`Jg2Jhg*/ a/a!&$@/ aX/ a`X/ a@X`JL N^NuHV,O/ $n"R YJg  f YJfY$ f <v$_N^NuHV,O/ ."Wte. |: pNp`p`p `p `p `p` p`p`p$N^NuNVH?0$n&n HnBaH/.a*./.a-G/ a~& WreD |z p N(<v^`>(<vg`6(<vm`.(<vz`&(<v`(<v`(<v`Hna(Xp g$rgpgrgp g r gpfHna*XpЃreHna,XHna$ nXJgl PJgf  g`  gZHyv/aPJfF n/aV/a$ n/Hyv/aH n/a n X nJg* PJg$ (f/ n PI/Hyvap Jf / a7X"9\PaJf$JhgHyvaXJpga6JhfJpf Sre | p N//HyvaN `n///Hyva6`V//Hyw`///Hyw`*//Hyw+/Hywa`///Hyw+/HywaJhgJfHyw.a(Hywa4$.$nN^NuHV,O/ /$.HyyENB/a$Hx/aZ/aHyyN$.$nN^NuHV,O/ /$.HyyENB/a$Hx/a /aHyyN$.$nN^NuHV,O .r!|fr`fHyy`$Hyya$p`r`gHyy`Hyyap;N^NuHV,O/". n CpЁtd p?gt!fp g t gp f2| $N^NuHV,O/ p!|f6"y$ y $H 0 fS$ y$ 2 gHyyat$nN^NuHV,OJgHyyaXBHyyaBp#N^NuHV,OJgHyyaBXHyyap#BN^NuHV,OJgHyyaXBHyyanBp#N^NuHV,OJgHyyaDBXHyz a0p#BN^NuHV,OHyz"adRBBN^NuHV,OJfaHyz3aSBN^NuHV,OJgHyyaXHyxap##N^NuHV,OJgHyziazBBXJfHyzaXp#XHyzaBp##N^NuHV,OHyza p#BN^NuHV,O/ /$.HyzENB/a`HyzN$.$nN^NuHV,O/ /$.HyzEN/Hyu`aHyzN$.$nN^NuHV,OHyzaN^NuHV,OHyzap#N^NuHV,OBHy{aN^NuHV,OH <(n*n 4|:&UJg/ aXbB`dJg 3IfR$ `RJ3g 3If*fJ3gRHyva`"Hka$@/ / Ht(aB3 L<N^NuNVH0<(n$. &.BJf$<s{ /g .f< ,/g ,.f, ,/f$// aPJf/ a` `K08`jJf/ aHys{a&@P/ N$@/ NHra$@/ / Hy{ / a@/ aײ./ aHPJg/ aזXHn/a&@PJfBL< N^NuNVH88xEIHn/9٬/.a& g`&nB/aݶ(PmLHkaP(@$ X`/Hr/a* JnJooHj/ aF(@P`4rf.Jg / aXJg /aXpg/aB`Z/a#٘#ٜ#ٔ/a#ٰB٠r#٤ y٘"yٜ yٜ٘B( LN^NuHV,O 9Ro$p й#//9 av# 9 y !ٰ RN^NuHV,OS 9 y # ٰN^NuHV,OHxa @!yٔ!y٘!yٜ !y٠!y٤ #aBN^NuHV,O/ $yJfaXJg"/9٠/9٘a[/9٘aX y#J fJfa#ٔ#٘# ٜ#٠#٤/ aa$nN^NuHV,OH0 Jg*E%F$9ٔ&9٘a/ aH(@X /g. .f ,/g ,.f ,/f`/ a(@XJf/ ajHy{aV(@P/ aD$SX`SJg 4.(fJf / a"$X$B\/ aXd/ / ad(@P <{%Jhg <{/Ht(a`j /fd/ E08N$S/ N&@/ NHsa$@/ / a݊`S 2/(g Jf 2/(fR/ Hr(a`/ a҄ ` L<N^NuHV,OH <*nJgJfHyvaL` /gB .f -/g2 -.f -/g ~gpHxa>$/a"PJf*// /9Hy{+Hy(aHxaHy{>/E/N/ /N/a$@/aѴ` -/f^Hy{@a&&@XHmE08NXAJg/ NX`B/a$@BXJg / / a0PHm/ a`Hxah @tX-` (R5(Igr/fJgB0(/aҊ(@XJf / a`8/,E08N&@ԍ/NHsa$@/,/ aۦ// ax L<N^NuHV,O/.BaN^NuNVH88(ntF/ a(XJ4HgHtHHnaJPp g rg` ..f|_Hx.$/aP&@PJf&B/ a X $ //& ք/a$C Ԋc. Pc&CH KA  P .f_RcbB .fXHx/ HtHaڴ`FHn$ Ԅ/a~/aڔrd(B4H`"HnHtHa\/ ar"SdB4( LN^NuHV,O/$.Hy{E/axPJfB4`Hyp?/a\Jgp` p#4B$.N^NuNVHnHxafRPJ$f*/.aXJg/9وHx@Hyv,aX /.aN^NuHV,OH00$.&. Hxa$@/GT>N%@/N%@$@%y( #@R$@ 9/+ Hy|ax R0/+Hyu`aS0Hy|ax&`^$9ل/9وaj&R0/+/+/+ /9لHx@Hy|aS0#ل/9وa0#و aR< 9<&r JfBJhgHy|awXa/ aatL N^NuHV,O/ / JDfp#DJHf$Jg/9aX` <|#H/9H y|ACX/1Hy}EӴNHy}1avJxg yxACь/1Hy}dNPHy}qavXJٌf #Hٌ/9ٌHy}uGӴNHy}Hy}NHy}ENHy~NJgJLf/9HHy~Np#L$n&nN^NuHV,OH <&nBB3 g`Z`X`R RJ3fвf `/az$@BXK~IttCty3 gH`f J~ ~!~"~#~$Z`D JtutvtwtxX`$ Jtzt{t|t}X` RJ3fp/ aƠ L<N^NuHV,O/ /$.J4f$Jf Hx/9$asHy~%at Hxau$.$nN^NuHV,O/ /$.g>Hy~)at/. Hyu`EӴNHy~0NHx/aHy~8atp$.$nN^NuHV,O/ /$nJgdB &fHy~at@`FIAbCf(/Hy~@a>PJf/Hy~KasP`I/at@XRJf$.$nN^NuHV,O/ $n . g Jg // aHPHx#asXHy~P/ a2PJfHjHy~Vasb`/ a&$nN^NuHV,O/. /.aN^NuHV,O/ / $nJg0GbICf/Hy~[aXPJf-RJf$n&nN^NuNVH <*nHy~_/ aՎPJfJ gHy~c`"Hy~_`Hy~P/ adPJfHy~na"(@X`0Hxa@(@B.B&MX (fHx)/ aδ&@PJf/ Hy~|aMHxaB$KSplHxHy{%Hkaζ Jf[plHxHy~HkaΒ JfY L~~~~/ Hm$/a^B2 /a// E/NHy{>/ NR / / K/NPJg*/ E08N$ Ԁ/ N/a:Hy{/ N/ aH L<N^NuHV,O//. /.aP$/aq^/aº$.N^NuHV,OHx/.a$N^NuHV,O//&.BXl. yPJ,g p,//a.PJf ` RXmp$.&.N^NuHV,O/.armB` yP 0 N^NuHV,O/$9`R`J\fHxa(#\X 9`R//9\a4#\Hx a y\!,/.a"y\ q, q,!n  q,!n$.N^NuHV,OH8&n$KJg"I%F/*N/*N&S/ N $KJfLN^NuHV,OH0 /.a&XmX yPJ<gL p<$( yT/0,a yTB, yP p</E%FN yP/0<N yPB<L N^NuNVH80(./a&@XvJg&+JgJ f 9٠R/aEXHnBaWaxPJgFJ f>/.a\T/a$/.Hy~/aB/aD/a: Jl /Hy~aI/.a `Hxa0$@ yT$<%nBX 9لfHyvaX%@ %k  9٤S%@/9ٔa%@ yT!<Hx:/*aX Jg/*Hy~aIPJlg //.aL N^NuHV,O/ / /9وaH$@/ G08NPrd / NB2X/ aR/ a"$n&nN^NuHV,OH0 &./atBXXl& yPJfB`fRXl yPJ f$JlJ$9XRX 9XR//9PESN#P 9XR//9TN#THxa yP!,/a\"yP q, q,!B q,!B q,!n yTB,L N^NuHV,OH8$.(. /a\/a0&/Hy~/a|BHye/a./a/aLN^NuHV,O/ / JTfH 9XR/ESnN @#T 9XB 9XR/N @#P 9XB PEXlPG%F yP p/a yPXJg p/N yP/0N yPBPRXmBHy~Eg NHxHy~NHxHy~NHxHy~N.Hy~NHxHy~N$n&nN^NuHV,O/.a` @pJg (N^NuHV,O/.aJm yT 0 `pN^NuNV/HnBaS/.a Jg/.Hy~aFP`V/.a"\/aN$/.Hy~/aƘBHye/a./.a/a /.a$.N^NuHV,OBaXN^NuHV,OHxaFN^NuNV/ `R٠ 9٠ٜg"y٘ @ 0 g 0 gHnHysBaRJ/.a$@`R٠ 9٠ٜg"y٘ @ 0 g 0 gHnHysBaQ/.axJmJl/./.HyaD ` yP"p p #h/.E%FN/.N$nN^NuHV,OHy~aN^NuHV,OHy~aN^NuHV,OHy~aN^NuHV,OHy~aN^NuHV,OHy~aN^NuHV,OHy~apN^NuHV,O"n n P/( Q/( ydNN^NuHV,OH<8&n(. z  @Hha&$@BBXobI%F Sg&"s< s< ) f/(/)aĆPJg %<,R` s</(N s</(N/3<N RnB,BJg r< <gv r</( r</(a&PJfZJhfR r</(a:r Ҁ/ad$/ r</(Hy?/aè r</(a r<!BR`z'<<RJ<fpB</ aL0$n& B(9٤*9ٔ,9hBhJgR$RJf  @Hha&@B$CXJg@',R s,#٤ s,#ٔ s,/(/*aJ s,!@$RPJfB,#٤#ٔ#hHykHx// a// a L |N^NuNVH?PJhfJٴfGJhgJg$/,/*aPJfHyadX`B/,a/a|&/,/a$/Hyadl/E%FN/N Hyad|XJ gJ l JgBR`B/ a&@S`Hx/ ah/ Hyad / a`Hy/ aBPJf"Hx/ a*/ Hyac`/ HyacP`JlgJpg/ /,aP`/,a $Xp1et2^/ aԀXd*//aB(PJٴfN/,Hy/aV/,a @:H/ahR`/ HyaS``/ a$@/,pJgp2/Hy/a/,K08N D:/ahJgB/ NrЁXd*//a|(PJg*`RJ2(g 2(IAb0fJg$ 2.(gJg/ /Hy/ab`/ Hy/aL /ahX`Hysag/ Hy a ai $LR F(p|Jf/E%FN/.NSBh/Nai#ـ#|#ٔ#٤ JhgHy.aa`JlgJpga~LBX` Hy6aZ*XJlg yH/(/a`aaBDp#| 9\ѹPp#H#ـJhgaJlg/9haPX"yhIAb0gHx/ aN.ab`lHx yhI/aH`RJlgBHxYaż`: yHJgf Ppg&p.gpgp/gp(gp1gpgp0gpgpga`x`JPgR`Bx`p#|#H#ـ 9\ѹPBD`~a`,p#|BDBHBـJhgVHyo`4a_BDBHBـp#|RLJhg HyaX.X`/Hya3FPJf Hysa=\LN^NuHV,O/ /$nJLgaX$p6f$Bg"/ EtN//N.Hya2`adJlgr5e | pNHxHx5`zHxHx6`pHxHx7`fHxHx8`\HxHx9`RHxHx:`HHxHx;`>HxHx<`4HxHx=`*HxHx>` / a"X`/ alX`HxHxYajPp5en | pNr#x`Hya\a^|X`STJPf`SPJhg Hy`Jٴfja^<``a`Vaa^" 9\PJhg4Hy`tJhgHyaVFX`rgp0g "9\PJhg <r+f < /aVX`l 9\PJhgHy#aUX`"9\PJhg.HyaUX`SLJhg HyaUX` Srd/ Hy*a0P/ atXSre" | p NJhgHyPaUDX 9\Pa\JPl/9PHyea0@$.$nN^NuHV,O//$.&9٤`: yH/(a/Hx@Hy yH/( /(a/avJHg&Jg yHpШrdp,gr-f#٤$.&.N^NuHV,OJlgBHx5aPHx+aDN^NuHV,OJlgBHx6aPHxaN^NuHV,OJlgBHx7axPHx/aN^NuHV,OJlgBHx8aPPHx(aN^NuHV,OJlgBHx9a(PHx1aN^NuHV,OJlgBHx:aPBa~N^NuHV,OJlgBHx;aPHxaVN^NuHV,OJlgBHxabPHx.aN^NuHV,OJhfJlga^` HxaN^NuHV,OJhfJlg Hxa`a(N^NuHV,OHx'axN^NuHV,O//&.$. HyhHys{Ba:/9ha6| yhJf/a/aҖ#hP"yhIAb0fN cB c6/a/Hya-t pf$</a0#hX/a$.&.N^NuHV,OHyHxa N^NuHV,OH>(.B*9ـ,9|aYp#|BـR`BِJhgHytaQP`x"y٘ y٠0Ip gLJgNr@fH 9ٜ٠r d6Hx Hy Rй٘/a` Jfp ѹ٠v`&R٤/aQ$R٠X"9٠ٜmxJgJfHya,8XJhg Hyu*aPS`#ـ#|L|N^NuHV,OHxaN^NuHV,OHx3aJN^NuHV,OHx*a8N^NuHV,OHxa&N^NuHV,OHx5aN^NuHV,OHxaN^NuHV,OJټg Hx!a`a~N^NuHV,OJټf Hx#a`a\N^NuHV,OJٸg Hx,a`a:N^NuHV,OJٸg Hx a`aN^NuHV,OJٸf Hx"a``aN^NuHV,OJg Hx-a>`aN^NuHV,OJg Hx&a`aN^NuHV,OJf Hx$a`aN^NuHV,OHxaN^NuHV,OHxaN^NuHV,O/ Jلf&HyEjNHy,NHywaon Hx)a$nN^NuHV,OJلfHya*Hywao4PHxaTN^NuNV/JLf/9وHx@Hya)j`HnBa6 nPJf/9وHx@Hya): /.aF$Xp6f*af/a //./9وHya(Jlg p)fa/a/.a $.N^NuHV,OH0 &.EA "HJgB/A $/1(aPJfAp(WID`RAC JfBL N^NuNVH 0JLg&yH 9٠ٜg6"y٘ @`R٠"9٠ٜg"y٘ A 0 g 0 g$9٠HnBa5vaT$@Pp5e + | p Nau`X&SJg`a/a//9وHya'`Jlg$a/ap/HyAa'l `Jhg.JXgHyiaLBXXHynaL X`Jlg a`aUHxaR*r#H#ـa`XJgv 9PU#(/aVJXJgFJgB @f,/ aX 2}gHjaXJg / Hys`/ Hyu`al(PHx aPR(X`ap#8 nJgS٤#٠`Jhg"9p,f&/9$Hyx/9 a\ JfB$Jlf6HxHy6 y $Hha& JgHysaJXHy}aJXJgJg/./ HyakF `/.Hyu`ak0Parf/.Hx@Hyak ar5f/.Hx@Hyaj aQ#,pHyxaJ X`\JlgBaJgJg/./ Hyaj `/.Hyu`ajPa8`HxaOXJlf 9t,f Hx aNXJِgJـgJ4g Hx aNXaQbHxiaIS$"9\R/aOBـPJgJg/./ Hyai `/.Hyu`aiPavrf/.Hx@Hy`aZr5f/.Hx@Hyai aP\p#ـ#H#,t/.a`/9وHx@Hya#L N^NuHV,ORlaHyk/9وaPJf&JhfJlg <tt` <tp/aCx#x$.N^NuHV,O// n$. "n". . JhfJlg//.//./ //a`DJٴg/// //aB`*vf$Jtg/// /Hxa `/aC($.&.N^NuHV,OHyHxHx"Hy/./. /.aDN^NuHV,OHyHxHx'Hy/./. /.aN^NuHV,OHyHxHx,Hy/./. /.aN^NuHV,OHyBHx^Hy/./. /.aN^NuHV,OHyBHx`Hy/./. /.aN^NuHV,OHyBHx~Hy/./. /.adN^NuHV,O/ .$9xBxJf yو Lg lg Og of yوJ(fJhfJlg" yو OfHyHyaP`(JhfJlg" yو ofHyHya` yوI/Hya@`Hyo/9وaPJfHysHya`HynE/9وaPJfHyHya`~Hyn!/9وaPJfHysuHy^ax`PHysa/9وaPJf/9وHy2aJ`"HysF/9وaXPJf/9وHyia`HysX/9وa*PJf/9وHya?`Hyn/9وaPJf/9وHya?`Hysd/9وaPJf/9وHy8a`jHysQ/9وaPJf/9وHyoaf`>Hym/9وavPJf/9وHya:`/9وHyaN#x$.N^NuHV,O"n pf^SF y 1 c B1//9وHx@Hy*a`* .rg/9وHx@HyXa`RFN^NuHV,O nBJg JgRJ fN^NuHV,O/ /$nJg"BJg/2,aXRJ,f/ a$.$nN^NuHV,OH0 &.EB`RJg$ y$p,JgJf//a,PJf L N^NuHV,OH80(./a&@XJf~ 9Tm&p й#//9ab#PHxa$"9 y! 9 yB  9 y&p R&X`$9ٔ&9٤/HyEjN# ٔ#٤/HyN#ٔ#٤Jg2B kJg k/0,aZXR kJ,f/+aBX/+ E%FN/+NP/.a'@ 'n'n'n B'nL N^NuHV,OH?<~ 9٠ٜg~"y٘ @ 0 g 0 g 0 g 0 fV"y٘ y٠ 0 fR٤R٠ 9٠ٜg("y٘ @ 0 g 0 g 0 g 0 gR٠KBB 9٠ٜg~"y٘ @ 0 g 0 g 0 g 0 fV"y٘ y٠ 0 fR٤R٠ 9٠ٜg("y٘ @ 0 g 0 g 0 g 0 g(y٠B y٘4`&p\f T٠t`p{f RR٠`p,fJgp}fpf&y٠Jfp}gHka|$@/ / ٘/ a B3XJg:GJg2 3\f"& ֋$R/aR///a RJ3f Tnp ܀ // a2*@P+\RB\R٠p}g<`np}f SR٠`R٠p fR٤"y٘ y٠0If LN#٘/9ٔN#ٔ/a#ٜB/9٘aRa$/9٘E%FN/9ٔNaS#X#xLN^NuHV,OH?8$.&. /9٠/9٘ab*9$(y0,9(.94$yـ&yِBـ(9Dp#D/a Jg/a/B/a0#$#0#(#4#ـ#ِ#DLN^NuHV,O/$.CBl4 yJg P`Rl yJ g p "٘f"HJg&o //)/9٘a//9٘a\$.N^NuHV,O//$.&. CBl. yJg P`Rl yJ g p f"HJgo//)/a//a$.&.N^NuHV,O . Jg/9"./HxЮ/ayN^NuHV,O/ Hx a$@X`R٠ 9٠ٜg"y٘ @ 0 g 0 g/ HyswHxa2/a Hyswa ,`R٠ 9٠ٜg"y٘ @ 0 g 0 gHjHysBa%y#$nN^NuHV,O/ /$.$yJg0//aPJf/ax/*a$P`$jJf $.$nN^NuHV,OH8Hxa(@X`R٠ 9٠ٜg"y٘ @ 0 g 0 g/ HysHxE&NHysG4NHlHysBNHysN HlHysBN)y #LN^NuHV,O/ /$.$yJg8//aPJf Hxa @ !y#p` $j JfB$.$nN^NuHV,OJf y P/(a&`( y P/(a% y#/awHN^NuHV,O/$.a/a~ B$.N^NuHV,O/$.aHn /Hy(aJ C(Sk i R`BC(J)l& D l i / iB/ar`Hy(Hx aq$.N^NuHV,OH8 &.$. (.a//HyHy(E%.NHn/Hy(aHy Hy(NLN^NuHV,O/ /$.a/9٤/9ٔHyHy(E%.NHn /Hy(aDHy Hy(N$.$nN^NuHV,O/ JgB/9٤/9ٔHy Hy(E%.NHn /.Hy(aHy Hy(N$nN^NuHV,OR2Jg6 92o(HyHy(au>afaHxabN^NuHV,OHx}Hy9aN^NuHV,OHy}HyFHyNa|N^NuHV,OH 0$.g/9HydHy(at `x/9HyG,NHysNHyE-N/9/9HyINHysN.kNHy,N/<P/9/9THyNHysa{HyE-NHyNHy.NHyNHyzN/a@L N^NuNVH88&.(n BHyvHxE.NHyvHxNHyvHxNHyvHx`Jf .A>Jf AB"0pЁt9e | p N/9`ptDfp/a>P`Bp#l#p`HyHyuc/9`a} rg/9`/9HyR`Jf`#`THys}/9`a}PJgHyk/9`arP` <#fN/9`HyaP`6Hya`$HyTHyuc/9`a}* tg/9`/9Hy`dB`J٬fHys{aN#٬X/9٬E08N&@/9`NHs/9٬az#٬Hysy/E/N/9`/9٬N `v/9`a#`^/9`aC6XJlL/9`/9HyHy(aqHxa`J٬fT/9`a#٬/a|pV//9٬a#٬Hys{Hysy/E/NXO.N`/9٬a0$/9٬E08N&@/9`NHs/9٬ab#٬/9`/a{Hysy/9٬E/N ./9٬N/ap `DHyHyuc/9`a{H rg /9`/9Hy8`/9`aXJl,/9`/9HyJHy(apFHxaTt#$`HyHyuc/9`az rg/9`/9HyHy`Hy(aoHxa`fR`^aHyvawHyHyaw^Bao"t#h#ٸBټ`Bp#l` HxaXHnHy6Hy4/ /a"tfJfBضf@B9/aqXJfx`&/9HyHy(anHxa JٴgXJhg.Jg&/9HyHy(anHxaBJfHys}a#XJgazJf*g4 9/4 RaXf`HyHyaJ2VIrLN^NuHV,OH 0"y٘ y٠0I/aXJg&R٠p fR٤Hysa$@`G"y٘ 9ٜ`RR٠٠g8 y٠0Ig*r g$r gr gr gr{g r}gr=fHka$@ 9٠/ / й٘/aiB3 L N^NuHV,O/.Hyax JVIDN^NuHV,O/ $n/ ax$XJgpB`Ro. 2 g 2 g 2 g 2 gHr/ awP/ awJgSrl 2 g 2 g 2 g 2 gB2$nN^NuHV,OH00&n/ awR/a$@BB/ aH JgJ3(8IRRr g r gr f$ 8`R3(Igr gr gr gJ3(fB28/ / av/ al L N^NuHV,O//&./9٠/a%l$Pm/avX"Ҁ`"9ٜ 9٠g"y٘ @R 0 fR٤fJl0,.&n $9٠*//a$(Pl(9ٜ$D&S/avրXg"y٘ BR 0 fR٤fHja&/ /ڹ٘/ag\ SB2#٠ٜo #ٜ٠ L |N^NuHV,OH8<&.*n (9٘(UJg/ Hx@ Є/anr JgFHla$@/ / 9٘Ѓ/af B4XJgJ fJf /a\XB/ a: $/au&@/ ajg"ҋҹٜRJ g/Hy٘a8` 9ٜRd//9٘a#٘P yٜHh 9٘Е/ C٘Hsam ѕѹٜ / 9٘Ѓ//aePO.ai`X٘g /aXJgJ f//9٘a0L<N^NuNV//9٠Hysa"|-@Pl-yٜJgHn/9٠a:P$9ٜ#ٜ/./. ar#ٜ$.N^NuNV/ .$n RFJg>RHnHysHxahSB/.a8d$/.ahj`/ HysBa4 /a"y٘ y٠ 0 f R٤R٠SF$nN^NuHV,OJ٠g S٠"y٘ y٠ 0 fS٤N^NuHV,OH 8$.E/ar(@&y٠Xٜl 9ٜSo y٘ 3@fR`^ y٘ 3{fR`* y٘ 3}fSJg8` y٘ 3 fR٤Jm*f/ / й٘/arH Jg Rٜmz(K٠HlaL$@/ / 9٘й٠/acB4#٠ n LN^NuHV,OaBaa a 8B,N^NuHV,O nBJg  " @Jf N^NuHV,OH88(n(. GBBa,f` @n@// a&@P/ Hx@HxHs(afJ$@Jl/amHxaVPԊJg,g#٘#ٜ/ET>N#ٔ/N#ٰB٠p#٤"y٘ yٜ /aLN^NuHV,OH< *./apr2Ҁ/a&aBPEF` rLJfHx./apPJfBR$J(g2//ap/ anP// G/NHx/ ah,rfpgv/ / an/ an Jg Hy{>/ NP// anpHx/ agrf>pg4/9anz// HyaJHxab/andXJgHy{>/ anPHy/ am L<N^NuHV,OH<0*.BB/9٘a(B٠HxHy=/9٘anJfHysaX`J٠oR٠J٠m6/9٠Hya:"@#٠Pgo y٘ 0 fJlJf/a#XE 9ٜSo" y٘  g 9ٜSRo 2 f$ RE`RoN y٘ 2\fHxHyD J٘Hham Jf#٠`Hyalѹ٠XJfHyHysaPJlgJpf/9awXJhf Jlg/9ad/9ad&/9aD$Hx./al @JgB/E08N&@/NHsa~$@// al// ak <JJhg <{// ak/9aa# `4p٠gHysaX`B٠ 9#(B/9a/9a#٨PJgtHys}/E0NPJf^JTg6Hys}/9TNPJf"/9HyOHy(a`LB /aJ(#BX`JhgZJgRHy/9E0NPJgHyv/9NPJfB`/9a#X/9`Jf//9a(P` /a(XHyk/a_|#P/aC*XJgR/9ٔ/9Jٴf&Jhf <Jlg <` <` </HyafJf/aX`a g/9a` Hya#XBr#٤٠g""y٘"9٠ @R 0 fR٤fJٴf2Jhf*Jlf"/9ٔHy}/9Hya aa|JlgavBaaajXJg/9a]XJ2gJfHys}/9TE0NPJghHy/9TNPJgTHyv/9TNPJg@/9T/9HyHy(a]/9TajJl/9TadXJgTaJ܆g*/9܆a#܆XJٴfJhfa:JhgaHy]a aXa g/9a\XJg/9܆aSrXJ\fJdgaqJg*Jhf"J2gJg/9/aWP`zJ2grJfjHys}/E0NPJgTHy/NPJgDHyv/NPJg4//9HymHy(a\J/aibJl /ac(X/a\@L gmp*g:m p&gx`p#BِBLS$`"9 J$g(Stg "y$ A 0 g 0 fS$`$N^NuHV,OR^N^NuHV,OS^N^NuHV,O/J$g~J^fvC$l6BJhf" y J1l1pFt f1R$m/9/9$Hx/9 aJ^ 9$ѹ,B$B0$.N^NuHV,O/$9b#bax#b$.N^NuHV,OBaN^NuHV,OJ"faaBp#a`" 9P(l 9(P/aXp#"N^NuHV,O/B"J4gJ8f"y$SJm& y B1r gr f y  `R#$Jbm Hx aXJLfDB`(Hx aXJhgJoHysaXR 9bnJLgaBaB4BDB(a $.N^NuHV,Op #p#ِN^NuHV,OH 0Hxa< y X  g 9$B0 9$Tl 9Tm( 9йT#//9 avT# P/9 aR&@Hkav$/ //9 aDP EP` y  R 9T$n/ 9 Њ//aDPO.aG#T$/ BaL N^NuHV,O/J4gaB"p#4J8f`JDf^J|g$9PJ|l$R|`Jl$9P` $9PԹ(m(/aչ(`B8$.N^NuHV,O/$.Jhf"//9$aP` Hx aXSj$.N^NuHV,OH8&.$. /aQn(Xٜl*// й٘/aQZ Jf ` RٜmpLN^NuNV//Jgz$9٠&9٤HnHysia*"y٘ y٠P 0}fR٠٠l.-y٠#٠#٤RHn/aSP/.aEXHnHysaݼ"y٘ y٠P 0,fR٠/.a .$.&.N^NuHV,OH<`0Jg/ // HyOa `/ /Hy`a / E%FN/ N/NL<N^NuHV,OH N'@/N'@#fL N^NuHV,OH 8$.G$yfI%F`&J$RJg0//*aAPJfJg&`#f/*N/*N/ NLN^NuHV,O/ /$.$yfJg//*aAPJf *`$RJfB$.$nN^NuHV,OHxaN^NuHV,OHxatN^NuHV,OHxabN^NuHV,OHxaPN^NuHV,O/ Bat$@XJgB/ aZXrl*/*/aGlPJfJg/*Hy~aP/ a>$nN^NuHV,OH0 &. $nJf"Jjf #0nRjR``$Թ y B2/ad$/a" (#$Ppnfa1vpjf"0n0o#n0p#nSjJg/Hyu`a`/HyzaXO.a58L N^NuNVHnBahP 9٠ٜla/./.a/.a4N^NuNVH80$.&n C KBJgD  g8  g2 "g 'fIfB`IRJgJf  g  fJgRBJf/9وHx@Hya6`(pg>m pg`pm`4JgE/ aX`Ev/ / aN`/ a`(9٤pf2yo4yo5yo6yo7yo8yo9`@yojyokyolyomyonyooyopyoqHna>&Xpf/ aXJgpf/ apXJgBG`HnBaʘ$nP`R  g  g @f/HnHja> JfR`vHxHy/ a> Jf\A`RJg  g  g"HJg  g  gRJg  g  fBHn/a=tPJf Jf6|`S/.a2XJfJ 9٠ٜm(Jf6HnHy//9ٔa`pf Hx%a` HxaL N^NuHV,OH0 &.BEJrg8vl0 yrJg P`Rvl yrJ,g p,Jf$HJf 9vRzmB 9zV#z//9ra` #rPzl yrB,RzmHx a_"9v yr! 9v yr$p RvBBBXo//a_$%C L N^NuHV,OH0 $n . BJrgbvlZ&R yrJ,g@ p,rf4"f.c8//a_4 yr p,$ yr p,!C`Rvma,L N^NuHV,OH0 &.HxaZ$@$p%@Hn //a>aZB٠#٘/9ٔa_T#ٔ/a;@#ٜR aB/9ٔa00aZS BL N^NuNVH?<$9$(94*9(,9ـ.9H(yD*yx-y0-y-yِJوg/9وa^X&`BBـBHp#DBxap#4/. <u`J g </aa$y$Hja]z&@/ / 9 Ђ/a+ B2Hyوa#و#$#4#(#ـ#H#D#x#0##ِ L*'g /*Hy` /*HyaBXO.HyaBP$RJfHya\S`a.#D$.$nN^NuHV,OBa N^NuHV,OHxaN^NuHV,O/ $nHy~_/ a3Jf~_ J~`~a~b$nN^NuNVHnHys/.a "y٘ y٠ 0,fR٠/.aR/.a| .N^NuHV,O/$.g(R`B/a$S`/a/a@ $.N^NuHV,OH00&n$y܆Jg" jf/ /*a,HPJg$RJfJfB`~/a!dX`h/ al&$y܆X`>Hx@/*a+PJg(/*aB$//a+ Jg/a!X$RJg//*a+PJf/a L N^NuHV,O/ /$.$y܆JgJ,g//*,a+~PJg$RJf $.$nN^NuHV,O/ /$.Hx aN$@XJg>$܂/aOn%@p%@/aJg%@`R܊%y܊#܂$.$nN^NuHV,OH> $n*. (.,.&.$Jg&/ a` @XJg/(/ Hya`f#ل/ a$Hx0aM @!J!E!D !F!n!n!yٰB !C$PJg!B(`R܊!y܊(!n , ܆#܆Jhg/EN/N/NL|N^NuHV,OH< $.&. (.Hx aM\$@/ad*$~/aN%@%C %y܎%D 9لf <v/aM%@%yٰJg%E`R܊%y܊#~Lv.f.J2g2 2 g* 2 g" 2 g 2 g 2)g R0IfB0L N^NuNVH<*9٠&9٘(9ٜHxHy RЃ/a( JgB`4V٠HnHysa@RB/.ar$S/.ar#٘B٠/a(P#ٜHnHysyBa&"y٘ y٠$ 0:fR٠"y٘ y٠ 0:g*/.a HnHysBa/.a:#٘#٠#ٜ/a/.a/.a@/.a' @Jg"n 1:fB1Jg/. /9٤/.a0 .LJ 9܎Rܮf&`*R"CܪJgAܮ 9܎Rf&1/Hx@/HyMa`D/a*X`"/a R/(`LHy~_/a"PJf (y٠*yٜ&9٘&y/aHy~PaF.P$9٠//9a XO.Hya"@#٠Prl\ y٘ 0 g 0 g 0 g 0 f6B/9٠Hyaв#٠PrgBBaB$PJf Jg4/9ٔ/+a!PJf#٘#٠# ٜ&S`:#٘#٠#ٜJN.PJg* nJf //(NPJf/N n/(N*P f`$Rf Jg, RJfJg Jf/ R/(a PJgJf:Hy~_/*a&PJf$/a/*aD,P` -J$RJfJgJ fJf&9$(y0Jhg/a NX$@`E/G08NE/N/NHraCX$/// <vJhg /Hy/a$.a/a#$#0P DJf>/9وHx@Hya/E%FN/NB/NB/NBR܊`b EJf /aBX FJf /aBX GJf /apBX/././9٤/.////ap#ܒ JhgJg DJgJf/9a?$/E/ a/./ a/aJf&Hyk/ a#BDaJP`H n('g//(Hya`Hy n/(/(ENHy6 n/(/(N$ n/(,aZ nB,HykHna#BDaJ^`HyhHna#PgHx"9ܖD//a Jm6/9Hx$/a JgHyܚ/a#PJg*/.Hykar/9a.HxaAHx 9ܖD//9a JfHna"HxaAzPHnaXJfPJٴg6HyEN/a8$B/aLHyN/aJf Jٴf <Jg <v/HyGӴNHyHyN/a$B/K`N/HyN .I%FNXJgFB/ap$HyENHyNHyNHx/N/HyN .NXJgRB/a&$HyENHyNHyNHx/aK/Hyal .aXJgRB/a$HyENHyNHyNHx/aKr/Hya .aX <vJg </HyaP`*Jpf JlgJg*BHxE@FN/Hyu`aߚHxHxNJg*BHxE@FN/Hyu`alHxHxNJgBHxE@FN/Hyu`aJ`gJPfJTgHy~%ap#XXHyENB/ aIHyNJg / aK*/aT @PJgR('g/(/ HyC` /(/ HyaPO.sE NHy6N/a B `/9a9$/&/a//a`/a Hyk/a p( f/aJHxa

Hx@/*a`PJg(/*a$//aJ Jg/a xX$RJg/*/a&PJf/a V LN^NuHV,OH 0$y~Jg"G%F$ /*N/*N$R/N JfB~L N^NuHV,OH 0$y~JgG%F$ /*N$R/NPJfB܂L N^NuHV,O/$./a @XJg ((`0/9~/a @PJf/9܂/a @BJg ($.N^NuHV,O/ $nJgJg (g/ a @XJgR p`# ٤/ /.HyaB$nN^NuHV,O .grg ` <` < ` <N^NuHV,O/ /$n$9ٔJg,#ٔ/*a//* /*aL$RJf#ٔ$.$nN^NuHV,OH><,.*9ٔ&FJgKZI%F#ٔ#٤+'flJ gHy./+/+ a/+ a$@Jg*'f$*BJg/+/aPJgxJgjJg,/N&/+N$//aJfB/N/NPJg2/+Hy3a~/*HyZ/*/*a p$+'fFJg>Hyz/+/+a Jf p$`BJg/+/+a PJfxJfJg2/+N&/+N$//aJWID/N/NPJf/+aB$@XJg*'fBJ g/+/* aPJgxJ g:JglJg./* N&/+N$//aTJfB/N/NPJg2/+Hya0/*Hy/*/*ap$Jf<+'f,Hy~_/+aRPJg/+HyaP`JgHy/+/+a Jg k (gB 9~` //+a$@PJg$/+/*apPJfJg( `JfJflJgd/+a& 9~` /ap ./+a\$@PJg6/*ad$//a JfJg( `/a*XJf0Jf,/+ah$@/+/+Hy/*/*ab&SJfv/9~a&FXJg+'g&S`z + o(#ٔ#٤/+ /+Hya J f@#ٔ#٤Hy~_/+aPJg+'f/+HyDavP&SJft#ٔL<|N^NuHV,O npJg P('fBN^NuNVH? vmARB vlAR Aܲ/0/a/`Hyva*$.&.N^NuNVH? ,... $.axBHBـ*9Dp#DJgJ f"9٠R/aXHnBa(9 ع$/an& l/Hya`//aX/a JgZJ fR/.a(T/a)T$/.Hy~/a/9٠/9٘a}/a~.aX`/.Hy~a:P$y $ Aܶrf$B/9ل/Hj/a)fXO.a/.a& SBXo/a^XRnHx a^ap#ـ#DLN^NuNVH<0&n&. BaBHBـ*9Dp#DHkHyavPJلg yلJfT$y $/9RHyHya8$9 Թ$/Hj a(p(Hya@$y $JgJ f 9٠R/a~XHnBa/aL$ l/Hyal`// a6/a Jg<*.(.&.BJf(<v 9"R//9a#*#Hxa""9" y! JhgFJf/aҰ$(BX`$JgJf /a1` /9a *,X/G08N$@E/NHra"v&@$K JfJgK~ &f& J~ ~!~"~#~$Z`LIAbCf8/Hy~@aPJf$B/Hy~K/ aT Jg RJf`RJf Jzzz` // ajP// a:/E%FN/N 9" y p ` 9" y p /a"B"9""y q!@ q!n  q!A q!FR" L<|N^NuHV,O//&.f&<vB"l4 y p,/(/aPJf y p, ` R"mB$.&.N^NuHV,O/ /J"g`B"l>E%F y p,/N y p,/(N y/0,N R"m/9aFBB"$.$nN^NuHV,OH8 (.J"gaHyHy/a y P$(B "lP y p<l6E (od/HyiaPR y p< (n`< y p<o,E`/HyalPR y p< nJg y"pfHJFf@ yJ($g4a @"yAJ gaHyap#>XJf2J>g*"yAJ$faHyaB>Xrf2J>g*"yAJ$faHyaNB>XJf.J>f"yAJ$fa&Jf / aX`aHxa r#BLN^NuHV,OB/. /.a&N^NuHV,O/ /$9xJVgJpgJfJPfvJTfnJ>f>JFf6Jf.a @"yAJ gHyap#>XBxHx&Ef.J|f&p g^p gVp gNp gFBBa< @"yAJ g4J>f6Jf$JFfa&Hyyap#>XJ>gp fp#BXJ2g*HxHxE@FNB2HxHxNB.p fJ>fJ|gF#XJg / Hys`/ Hyu`aXO.HxAa`4 K @fR/HyBHx@aRn 9nA@B $n&nN^NuHV,O/ / .r'g^e rg`r3gr5f 9nG@J g(HxHxBE@FNHxHxEN 9nB HxHxD`4 9nE@J gHxHxBa 9nB PHxHx@aSn$n&nN^NuHV,O 9nA@J gHxHxBaPBHxBa| 9nA@r! N^NuHV,O/ JRf> 9nA@J gHxHxBE@FNHxHxENBHxEaPBHxFa 9nA@r! BR$nN^NuHV,OHxHxFap#RN^NuHV,O"nJpf / Hy`fIAb0g 1f BHy`DBHy`:IAb0g Af BHy`BHy3` afBHydBHxCaz`BHy|BHxCadRn 9nA@B N^NuHV,O/ 9nE@J gHxHxBa 9nB PHxHxCaSn$nN^NuHV,OH80$./aZ/a&//apHy)/a>Hyn/aV&@ Jg$9|(9ـBHxcE@FNBHx=Np#|BـBِ` /aXSk kBR` / aXXrf#|#ـHxHx=E@FNHxHxcN/ alJg,/aX` /9a//Hyac/a٢L N^NuHV,OH 8$.BHx_E@FNBHx`NBHxaN/HyBHxbI=|N(G $n(9&9 ,9`h "l2$Co$ *"҉ r Љ% % Rn䜂`*$Co"҉ r Љ% % Rn؂lm 9 ѹ# L|N^NuHV,O/ $n 9# #BHya# -f p#R`( +f BR`JgB`p# $nN^NuHV,OH?<*n ..B`JgJ!`f,Jfp#// /.aH.p#!` Jg yJf y o # 9o #pf y g 9 g$/ aX` y g # .o*`R no 9 u -fJ(g# .g~Hy 9/5 ajPJfVR y g( 9 g / adX` y f ## # .f y g&#` 9 u -fJ(f(Jfp` 9# `Rp`"9BJg u (-WIDRе#Jg 9 u (-g&JgJ(f(I//aNPJfIBBx&y`RJg =f$nB`Jf(J(`zRJg< K//9/a, Jf$ /aXf(J(|JgDJf@Jg" 9/5 /HyHy(a/9a־ѹ`JgL&RJgJg R#``JgX 9 u (-f//HyHy(aT`*/ 9 u I//HyHy(a(/9a"ѹ# p?`pfx no 9# `R`VJg" 9/5 /HyHy(aʴ/9aծѹ# p? G :fdp:`^/9aՂѹJg n Jfv`Jg, 9 u (-g yI//a PJf|JgX 9 u (-f/9/HyBHy(a`*/9 9 u I//HybHy(a#vRBp?` yRI//al"@ yPJfRJg :fTJg>JgI//HyHy(aH`I//HyHy(a,I#p?` WfP );fFIBBB yJg#``V nfJg,Jg& * R! Rc") )Щ d$ Б"@XJf&(LN^NuNVH00&nJ g$k BJg /aHրXJf`/+a4&X'C$/aƌ-@/aƀ-@BBPp-@BJ g&$k Jg8HnHnHn/aJf`HnHnHn/+a/Hna*'@ &'nL N^NuHV,OH0 &.$y$`$jJgZJf / aXe涪dJf`< `:B"jc.$j Љ" rd"A` (Ш b$RbBL N^NuNVH8 n&n  &Hyv/E0NPJgHy,/NPJg S zgB`n/af$@RHy,/a" Jf'Z`BHk/ I_4NHk /aV$@B'@ S zfHn/ N$@ LN^NuNVH 8$n&n (n"nBgp?L,ё`@Jl&p?-@Hn/ a$@".L, -A`tgp?-@B3x`p/e |6 pN"`Bё`B0ё`"ӑ`Hn/ E_4NHn/N$@ .L, -@ .x .A! `Hn/ a$@ .B3x`lHn/ E_4NHn/N$@ .x .A! `8Hn/ E_4NHn/N$@7nt'n`Hn/ a$@7nt`Hn/ al$@'n`Hxa$Hx// a'B`$+Hx/ /aPO.a4`r-ApeCxA .".pЁ!Rrd``Hn/ a$@'n `JHn/ E_4NHn/N$@ .L, -@ .x .A".D! `at LN^NuHV,O n !nBBB B!y$#$N^NuHV,O/$.Hxa//a$.N^NuHV,O . n !@!@ BBB!y$#$N^NuHV,O/$.Hxa//a$.N^NuHV,O/ .C$Jg* Qf$H"Jg /* a ` QCJfaz$nN^NuHV,O/.a/a|N^NuNVLH< (.*. /a$@XJgHn/ a$PfB`HxHnVaP=n-nZ *Y J&XcBHnHnV/a$btԊ n zfHnR/a$ԮRP В&X-jN`HnNHnHnV/a$cNdHx/HnVa L<8N^NuHV,OH0<*n&n &-r 刟(OBc@`, U"p,$p )j + S! R UB"4pf),"RbBBc UJ,g!,RRb+AL< N^NuHV,OHyjHyjHy a @/( aN^Nu %d=jT=dP=^D=X@=R<$P8$J420$V,$D$,$&$ $>($\H$ $2$$$$8 (d.L) )))%F)2-z" ($    __eh_frame__TEXTtitlespecinfoincludeiunnumberedsubsubseciunnumberedsubseciunnumberedseciunnumberedisubsubsectionisubsectionisectionichapteriappendixsubsubseciappendixsubseciappendixsectioniappendixseciappendixxrefwvtablevindexverbatimincludeverbatimverbvarvaluevurlurefunnumberedsubsubsecunnumberedsubsecunnumberedsecunnumberedunmacroudotaccentubaraccentutoptodaytitlepagetitlefonttindextieaccenttextabletabtsynindexsyncodeindexsummarycontentssubsubsectionsubsubheadingsubsectionsubheadingstrongssspsmalllispsmallformatsmallexamplesmalldisplaysmallbookshorttitlepageshortcontentssettitlesetshortcontentsaftertitlepagesetfilenamesetcontentsaftertitlepagesetchapterstylesetchapternewpagesetsectionscsamprmacroringaccentresultrefillrefraisesectionsrquotationquestiondownpxrefprintindexprintpoundspointpindexparagraphindentpagesizespageoptionoeonwnodenoindentnodeneedmultitableminusmenumathmajorheadingmacrolowersectionslisplkindexkeykbdinputstylekbditemxitemizeiteminforefincludeimageignoreiftexifsetifnottexifnotinfoifnothtmlifinfoifhtmlifeqifclearihyphenationhtmlheadingsheadinggroupftableformatfootnotestylefootnoteflushrightflushleftfindexfinaloutfileexpansionexdentexclamdownexampleindentexampleerrorequivenvenumerateenddotsendemphemaildotsdotlessdotaccentdocumentlanguagedocumentencodingdocumentdescriptiondmndisplaydirentrydircategorydfndetailmenudefvrxdefvrdefvarxdefvardefunxdefundeftypevrxdeftypevrdeftypevarxdeftypevardeftypeopxdeftypeopdeftypemethodxdeftypemethoddeftypeivarxdeftypeivardeftypefunxdeftypefundeftypefnxdeftypefndeftpxdeftpdefspecxdefspecdefopxdefoptxdefoptdefopdefmethodxdefmethoddefmacxdefmacdefivarxdefivardefinfoenclosedefindexdeffnxdeffndefcvxdefcvdefcodeindexctrlcopyrightcontentscommentcommandcodeclearcitecindexchapterchapheadingcenterchapcentercartouchecbyebulletbasisappendixsubsubsecappendixsubsecappendixsecappendixsectionappendixanchoraliasafourwideafourpaperafourlatexafivepaperaeacronymaaTeXOEOLHAEAA~}|{`^@?=:.-,*'"! space
linebreakhellip..............•bull©copy(C)DecemberNovemberOctoberSeptemberAugustJulyJuneMayAprilMarchFebruaryJanuary%d %s %dtt<><><>[](),unlikely character %c in @var@sc argument all uppercase, thus no effectem

`{' expected, but saw `%c'end of file inside verb block`}' expected, but saw `%c'
%c%s is obsolete%s%s%d@sp requires a positive numeric argument, not `%s'lines="%s"

INFO-DIR-SECTION

=>=>==>==>==-|error-->error-->-!-%*s%c%s `%s' %c%s `%s': %sBad argument to %c%snoneMissing `}' in @def argFunctionMacroSpecial FormVariableUser OptionInstance VariableMethod@@@@%s`%c' follows defined name `%s' instead of whitespace

-- %s: %s -- %s: %s %sof -- %s %s %s: %s -- %s %s %s: %s %son @def
%s function<%s>%s%s <%s>%s %s %s %s
@findex %s @vindex %s @vindex %s %s %s @findex %s %s %s @tindex %s Must be in `%s' insertion to use `%sx' %s   &ldquo&rdquo %s/%snoname.texi.html.info%s: getwd: %s, %s /HOMEseparate`%c%s' needs an argument `{...}', not just `%s'No closing brace for footnote `%s'Footnote defined without parent nodeFootnotes inside footnotes are not allowed%s(%s) (*note %s-Footnote-%d::)-Footnotes

Footnotes

    %cnode %s-Footnotes,,,%s ---------- Footnotes ----------

  1. %canchor{%s-Footnote-%d}(%s) %s
Untitled %s 4.1

%s

&

$-_.+!*'()%%%x(dir)%.3s-._Topindex.html../index.htmlInvalid node name: `%s'.inf../%s Unknown index `%s'Info cannot handle `:' in index entry `%s'%sindexcpfnkypgtpvrIndex `%s' already existsUnknown index `%s' and/or `%s' in @synindex%s <%d>Unknown index `%s' in @printindex

    * Menu: Entry for index `%s' outside of any node(outside of any node),
  • %s: %s#%s* %-37s %s. %-*s See %.*s. See ``%s''. See node %s.
bad_typerawtexrawhtml@ Broken-Type in insertion_type_pnameEnumeration stack overflowlettering overflow, restarting at %c%c. %d.
    %cend %s* Menu: START-INFO-DIR-ENTRY @end documentdescription

    @bullet%s requires an argument: the formatter for %citem
      

      begin_insertion internal error: type=%d`@end' expected `%s', but saw `%s'END-INFO-DIR-ENTRY
end_insertion internal error: type=%d
end_insertion internal error: current indent=%dNo matching `%cend %s'%s requires letter or digit1end verbatimend of file inside verbatim block@menu seen before first @node, creating `Top' nodeperhaps your @top node should be wrapped in @ifnottex rather than @ifinfo?@node top @top Top @detailmenu seen before first node, creating `Top' nodeUnmatched `%c%s'`%c%s' needs something after itBad argument to `%s', `%s', using `%s'@%s not meaningful inside `@%s' block@itemx not meaningful inside `%s' block

  • %s{}
    %s{%s}%cfindex %s %cvindex %s %c%s found outside of an insertion blockyumlthornyacuteuumlucircuacuteugraveoslashdivideoumlotildeocircoacuteograventildeethiumlicirciacuteigraveeumlecirceacuteegraveccedilaeligaringaumlatildeacircaacuteagraveszligTHORNYacuteUumlUcircUacuteUgraveOslashtimesOumlOtildeOcircOacuteOgraveNtildeETHIumlIcircIacuteIgraveEumlEcircEacuteEgraveCcedilAEligAringAumlAtildeAcircAacuteAgraveiquestfrac34frac12frac14raquoordmsup1cedilmiddotparamicroacutesup3sup2plusmndeghibarregshynotlaquoordfumlsectbrkbaryencurrenpoundcentiexclnbspISO-8859-15ISO-8859-14ISO-8859-13ISO-8859-12ISO-8859-11ISO-8859-10ISO-8859-9ISO-8859-8ISO-8859-7ISO-8859-6ISO-8859-5ISO-8859-4ISO-8859-3ISO-8859-2ISO-8859-1(no encoding)ZuluzuChinesezhZhuangzaYorubayoYiddishyiXhosaxhWolofwoVolapukvoVietnameseviUzbekuzUrduurUkrainianukUighurugTwitwTatarTsongatsTurkishtrTongatoSetswanatnTagalogtlTurkmentkTigrinyatiThaithTajiktgTeluguteTamiltaSwahiliswSwedishsvSundanesesuSesothostSiswatiSerbiansrAlbaniansqSomalisoShonasnSamoansmSlovenianslSlovakskSinhalesesiSerbo-CroatianshSangrosgSindhisdSanskritsaKinyarwandarwRussianruRomanianroKirundirnRhaeto-RomancermQuechuaquPortugueseptPashto, PushtopsPolishplPunjabipaOriyaor(Afan) OromoomOccitanocNorwegiannoDutchnlNepalineNaurunaBurmesemyMaltesemtMalaymsMarathimrMoldavianmoMongolianmnMalayalammlMacedonianmkMaorimiMalagasymgLatvian, LettishlvLithuanianltLaothianloLingalalnLatinlaKirghizKurdishkuKashmiriksKoreankoKannadaknCambodiankmGreenlandicklKazakhkkGeorgiankaJavanesejwJapanesejaInuktitutiuItalianitIcelandicisInupiakikInterlingueieIndonesianidInterlinguaiaArmenianhyHungarianhuCroatianhrHindihiHebrewheHausahaGujaratiguGuaranignGalicianglScots GaelicgdIrishgaFrisianfyFrenchfrFaroesefoFijifjFinnishfiPersianfaBasqueeuEstonianetSpanishesEsperantoeoEnglishenGreekelBhutanidzGermandeDanishdaWelshcyCzechcsCorsicancoCatalancaBretonbrTibetanboBengali; BanglabnBislamabiBiharibhBulgarianbgByelorussianbeBashkirbaAzerbaijaniazAymaraayAssameseasArabicarAmharicamAfrikaansafAbkhazianabAfar%s is not a valid ISO 639 language codeunrecogized encoding name `%s'sorry, encoding `%s' not supported&%s;invalid encoded character `%s'%s is an invalid ISO code, using %c¯''aouAOUEeIiyAEIOUYaeiouyCccircAEIOUaeiougravetildeANOano/O/o/%c#Œœcm_special_char internal error: command=@%s%c%s expects `i' or `j' as argument, not `%c'%c%s expects a single character `i' or `j' as argumentmacro `%s' previously definedhere is the previous definition of `%s'\ in macro expansion followed by `%s' instead of \ or parameter name\%sMacro `%s' called on line %d with too many args%cend macro not foundallow-recursionquote-arg@quote-arg only useful for single-argument macrosmacro rmacro end macroend rmacromismatched @end %s with @%smakeinfo @node %s:%d: . %s:%d: warning: Too many errors! Gave up. Misplaced %ctexinfomakeinfo (GNU %s) %s Try `%s --help' for more information. Usage: %s [OPTION]... TEXINFO-FILE... Translate Texinfo source documentation to various other formats, by default Info files suitable for reading online with Emacs or standalone GNU Info. General options: --error-limit=NUM quit after NUM errors (default %d). --force preserve output even if errors. --help display this help and exit. --no-validate suppress node cross-reference validation. --no-warn suppress warnings (but not errors). --reference-limit=NUM warn about at most NUM references (default %d). -v, --verbose explain what is being done. --version display version information and exit. Output format selection (default is to produce Info): --docbook output DocBook rather than Info. --html output HTML rather than Info. --no-headers output plain text, suppressing Info node separators and Node: lines; also, write to standard output without --output. --xml output XML (TexinfoML) rather than Info. General output options: -E, --macro-expand FILE output macro-expanded source to FILE. ignoring any @setfilename. --no-split suppress splitting of Info or HTML output, generate only one output file. --number-sections output chapter and sectioning numbers. -o, --output=FILE output to FILE (directory if split HTML), Options for Info and plain text: --enable-encoding output accented and special characters in Info output based on @documentencoding. --fill-column=NUM break Info lines at NUM characters (default %d). --footnote-style=STYLE output footnotes in Info according to STYLE: `separate' to put them in their own node; `end' to put them at the end of the node in which they are defined (default). --paragraph-indent=VAL indent Info paragraphs by VAL spaces (default %d). If VAL is `none', do not indent; if VAL is `asis', preserve existing indentation. --split-size=NUM split Info files at size NUM (default %d). Input file options: --commands-in-node-names allow @ commands in node names. -D VAR define the variable VAR, as with @set. -I DIR append DIR to the @include search path. -P DIR prepend DIR to the @include search path. -U VAR undefine the variable VAR, as with @clear. Conditional processing in input: --ifhtml process @ifhtml and @html even if not generating HTML. --ifinfo process @ifinfo text even when generating HTML. --iftex process @iftex and @tex text; implies --no-split. --no-ifhtml do not process @ifhtml and @html text. --no-ifinfo do not process @ifinfo text. --no-iftex do not process @iftex and @tex text. The defaults for the @if... conditionals depend on the output format: if generating HTML, --ifhtml is on and the others are off; if generating Info or plain text, --ifinfo is on and the others are off. Examples: makeinfo foo.texi write Info to foo's @setfilename makeinfo --html foo.texi write HTML to foo's @setfilename makeinfo --no-headers -o - foo.texi write plain text to standard output makeinfo --number-sections foo.texi write Info with numbered sections makeinfo --no-split foo.texi write one Info file however big Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org.xmlversionverbosesplit-sizereference-limitparagraph-indentoutputnumber-sectionsnumber-footnotesno-warnno-validateno-splitno-pointer-validateno-number-sectionsno-number-footnotesno-iftexno-ifinfono-ifhtmlno-headersmacro-expandhelpforcefootnote-stylefill-columnerror-limitenable-encodingdocbookcommands-in-node-namesD:de:E:f:hI:o:p:P:r:s:U:vV:wx--error-limit%s: %s arg must be numeric, not `%s'. Couldn't open macro expansion output `%s'Cannot specify more than one macro expansion output--fill-column%s: --paragraph-indent arg must be numeric/`none'/`asis', not `%s'. --reference-limit%s: --footnote-style arg must be `separate' or `end', not `%s'. --split-size2002Copyright (C) %s Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. %s: missing file argument. %s: --no-headers conflicts with --no-split for --html. stdin~{|}`^\@?=;:.-,*'" ! Expected `%s'.txinfo.texi.texinfo.txiCan't create directory `%s': %s\inputinput.xml%s: Skipping macro expansion to stdout as Info output is going there. /dev/nullXMLinfoHTMLtextMaking %s file `%s' from `%s'. stdoutThis is %s, produced by makeinfo version %s from %s. %s: Removing macro output file `%s' due to errors; use --force to preserve. %s: Removing output file `%s' due to errors; use --force to preserve. *
  • %s.%s@image file `%s' (for HTML) not readable: %s%s.png%s.jpgNo `%s.png' or `.jpg', and no extension supplied�"%s".txt@image file `%s' (for text) unreadable: %s@image missing filename argument{No value for `%s'}%c%s requires a name@endReached eof before matching @end %s@code{%s}
    Multitables cannot be nested

    nullfind_template width internal error: passed %sMissing } in @multitable template%200s@hsep@vsep@columnfractions%fignoring stray text `%s' after @multitableToo many columns in multitable item (max %d)multitable_item internal error: no active multitable
    Cannot select column #%d in multitableignoring @tab outside of multitable
    (Indirect)  Tag Table: %sRef: %sNode: %s%d  End Tag Table Node `%s' previously defined at line %dFormatting node %s...  File: %s, Node: Node `%s' requires a sectioning command (e.g. %c%s) @menu * %s, %s, %s, %sNo node name specified for `%c%s' commandAnchor `%s' and node `%s' map to the same file nameThis @anchor command ignored; references to it will not workRename this anchor or use the `--no-split' optionr+Unexpected string at end of split-HTML file `%s'

    %s Node:%s , Next: %s, Prev: %s, Up: %sAnchors `%s' and `%s' map to the same file name@anchor command ignored; references to it will not work%sTOC%d">%c%s is obsolete; use %c%s insteadNode with %ctop as a section already existsHere is the %ctop node%ctop used before %cnode, defaulting to %s@node Top, , (dir), (dir) @top %s Table of Contents

    %s

      %s: TOC should be here, but it was not foundError xml_element lang="%s"*** stack overflow (%d - %s) *** *** stack underflow (%d - %d) *** Element stack index : %d mark="%s"first="%s"numeration="Arabic"continuation="Continues" numeration="Arabic"numeration="Upperalpha"continuation="Continues" numeration="Upperalpha"numeration="Loweralpha"continuation="Continues" numeration="Loweralpha"@image file `%s' unreadable: %sfileref="%s.eps" format="eps"fileref="%s.jpg" format="jpg"index="%s"role="%s", %scols="%d"colwidth="%d*"xmallocxrealloc%s: Out of virtual memory! ferror on stdoutfflush error on stdoutPOSIXLY_CORRECT--%s: option `%s' is ambiguous %s: option `--%s' doesn't allow an argument %s: option `%c%s' doesn't allow an argument %s: option `%s' requires an argument %s: unrecognized option `--%s' %s: unrecognized option `%c%s' %s: illegal option -- %c %s: invalid option -- %c %s: option requires an argument -- %c %s: option `-W %s' is ambiguous %s: option `-W %s' doesn't allow an argument eh&small==$= =*=(=$=*=*===== =*=$=(================?v?H???????H?^??????^???H@(@(@@@@(@@@(@$@@R@R@R@@$@@@(@@@@@@@@@@@@@@@@@@@AA^B2B2B2AB2B2A^A^B2AAAB2A^B2B2A^BBBBBBBBBBBBBBBBBBB
      rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr{ {&{&{&{&{&{&{&{&{&{&{&{&{&{&{&{&{&{&{&wwxxyx{N{~xyzz{ { { { { { { { yxw.xxh{{ xxxx{y{y||||||||||||||||||||||||||`|||||||||||||||t|||V||||j||~||||}N~V~V~V~V~V~V~V~V~V~V~V~V~V~V~V~V~V~V~V}}}~}b}}~4}}}N~~~~~~~~~ }},}X}|~}}}}~V}~V}~~~~~~~~~~~~~~~~~~~L<<<<<<<<<<<<<<<<<<<<<V<V<<VVLLLLLLLLVVBVLLVVVV<L(fPf^index.htmln.n! njn0n,n*m0m5~mmtm)m+m.mm1m0m0m1mh0m_1ZmQ:mB1m81m+mmm m1m l.l0l/l0(l/$l:lilil)bllzl~lljlx0lnvllh(ld-jlblWlLlDl9/8l+/Ll/`l/tlk*pkk4k+@k-vkhk8fkjkk0kk-.k-.k-.k-.ks-.kj-.ka-.kU-.kF-.k:-.k+-.k-.k-.j0j0tEt<t6t0t,t't"ttt ts6nrr2r%qqqqqqqqqwq_qDq+qppppppppp-poooooojo^oWoMoCo:o4o.onnnnD=m+mmmkllk4ާڨsժϫˬǭîzsle^WPJC>82++$ zuoib[TNIB;50,% ΀ti^ S G ; / # sQ u rh e^ [S P@=52+(   x!un"kc#`Z$WJ%G>&;3'0'($)* +,-./012345~6{r7of8c\9YM:J@;=5<2+=(>?~ @ ABCDEFGHIJK}uLrlMiaN^VOSMPJCQ@:R7-S*"TU VWXYZ[\]^_`zawpbmfccTdQGeD=f:0g-&h#ijklmmnopqrstuvwx}tyqkzh`{]V|tVP}MI~F?<2/*'!H@setfilenameddtefshowo^ٸoWټo.Eٴٸټ,wcZNF5,%o prSVx v lll+l9rrrrsvllmrllornldtexinfosetfilenametitlefontsettitlenodenodenextnodeprevnodeupchaptersectionsubsectionsubsubsectiontopunnumberedunnumberedsecunnumberedsubsecunnumberedsubsubsecappendixappendixsecappendixsubsecappendixsubsubsecmajorheadingchapheadingheadingsubheadingsubsubheadingmenumenuentrymenutitlemenucommentmenunodenodenameacronymttcodekbdurlkeyvarscdfnemphstrongcitenotfixedwidthibrtitleifinfospcenterdircategoryquotationexamplesmallexamplelispsmalllispcartoucheformatsmallformatdisplaysmalldisplayfootnoteitemizeitemfunctionitemenumeratetabletableitemtabletermindextermxrefxrefnodenamexrefinfonamexrefprinteddescxrefinfofilexrefprintednameinforefinforefnodenameinforefrefnameinforefinfonameurefurefurlurefdescurefreplacementemailemailaddressemailnamegroupprintindexanchorimagemultitablecolumnfractionentryrowparabooktitlechaptersect1sect2sect3chapterchaptersect1sect2sect3appendixsect1sect2sect3chapterchaptersect1sect2sect3anchoracronymwordaswordcommanduserinputwordaswordkeycapvarnamefirsttermemphasisemphasiscitationwordaswordwordaswordtitleblockquotescreenscreenscreenscreenscreenscreenscreenscreenfootnoteitemizedlistlistitemorderedlistvariablelistvarlistentrytermindextermxreflinkulinkindexprimarysecondaryinformalfiguremediaobjectimageobjectimagedatatextobjectindexentryprimaryiesecondaryieindexdivinformaltabletgroupcolspectbodyentryrowbookinfoabstractreplaceablepara-F).F)!"6="("&)"p ?./bin/install-info 755 0 0 100000 7444752436 7305 l8__PAGEZERO X__TEXT ``__text__TEXT<0 __fvmlib_init0__TEXTlPL__fvmlib_init1__TEXTnN__cstring__TEXTnGN__constructor__TEXT}d]d__const__TEXT}h]h__destructor__TEXT___eh_frame__TEXT___DATA ` __data__DATA`__bss__DATA0__common__DATA08__LINKEDIT07/usr/shlib/libsys_s.B.shlibX< O .#/H#R/H#aZJg yNJg yNJ8gaBJCgaa$.atPNV-|lNq nd n"h n"P`N^NuHV,OHynHyn'Hy an @Hy/( a,bN^NuHV,OH8 (.&. $./9 HynHy(E%.N///Hy(NC(Sk i R`BC(J)l& D l i / iB/av`Hy(Hx adLN^NuHV,OH8 (.&. $./9 HynHy(E%.N///Hy(NC(Sk i R`BC(J)l& D l i / iB/a`Hy(Hx aLN^NuHV,O/./. /.aHxa"N^NuHV,O//.a$XfBBHyna $.N^NuHV,O//. /.a&$PfBBHyna $.N^NuHV,OH>8&.*. ,./E08N&@/N(/N(@AHHtaf$//E0N/G(/ N./ NB4 L|N^NuHV,O/ / &n$n Hja @Bo RnB2 $n&nN^NuHV,O/$.Hyn/9a.Hyna,B//a$.N^NuHV,O n *fR  g"HJg :g RJg :f/ /aLN^NuHV,O"n I *fA`R  gJg  g :gRJg  g :f :fR`  g  g`B (fC IJg  g )gRJg  g )f )f// a` <nN^NuHV,O/ //.a $@/ a$PpdHynHr(aPJfWB2(pdHynHr(anPJfB2(`pdHynHr(aLJfB2( $.$nN^NuHV,OH? $n$../aJ,/// axJWIDgXBBA"HJgH$1\/a(B//Hrha:Jf Є2WI&DRJf CJ\f LN^NuHV,O/9 HynHy(aHxa\N^NuHV,O/9 Hyoa4N^NuHV,OH8(.B/a$PlpfHxaD&/aߨHyu/a$g.HyuHyu/a/aJlB/a`8/9a///HyxHy(aHxa`/a,LN^NuNVH0<&.*n $n&nJfE$Hyx5/I%N$PfVHynHyn/a$Hyx5/N$f.Jg /N/a^$Hyx5/N$f /a"X/HxHxHna&rg"JfB/Hyx7a /aXJfG .f .f&xF`BJgT/HyxK/a&/aNJl /aXHyx5/a$Pg p n `,/ah`"BB/a Jl/aJ nB L< N^NuNVH< &.$.B*< /a$@Hn/Jf&Q//./.aN&/ /HxHrHa$l /.aXJg؂f*// a$@P`Jg /a`/a< n L<(n*. *n,.BBBGolJgB "`Hx Ћ& д8/HyyaN Jfp t8Z`R 0 (g 0 (g J0(g8 0,(g0 0 (g( 0 (g RJ0g 0,g 0 g 0 f/Hp(a U!@PR" Ћ mXBA t fJHxaz"@"B#KB BBBXJg U!K Jg UJg h!K *vJgHxA $/4(HyyaF Jf U!t(Jg UJg|A $ t(  gh *gb  g\  gVHxa$@A%HBB /4(/4(a|%@ U Jg h U h!K ` U!J U!JA t *f^R  g `RJg :fR :f /Hx:/`R  g (fH/Hx)Hha Jg0Ap)x`"JoA t  g  f A)RnJg U!E UJg h!E L<|N^NuNVH?<(.&n BBBIBBBBBBHynBaDPBHyHyy/ /arg rse |}h p NaTJg"/9 Hyy+Hy(a@a &90`Jg"/9 Hyy+Hy(aaR HyyVHyn/90a:& `NHxa$@/90a$ y0PJg 0 (g$HynHyy[/90a#0R %y0%BB B$-JR`aBa(XJg"/9 Hyy]Hy(aFa *90`0|-H`~`Hx a @!y0 p!@-HX``HyyHyyHyyE,NHynaܲHyyHyyNBaa`Jf 9*3 `,Jf 9&3 `B 9/3 Hyza R踹nJfBBHyza JfBBHyza Jf(BBBHn/aHn/./a(@ HnHn/./ a$@l, JftJfB/Hy{'aBaJoN nJ fDJf*Hx a-@ @!|x{ nB nr!AX nJg !n PJfHnHnHyBHn/aHn/./aV*@.aB EX`Sd (/f/a2$/a/Hn/./ ap-@Jf&.gh C(hJgT$l `So AJg)J $n`$RJg"/,/*a~PJfJg(, B&nJg$k `$RJgg/,/*a>PJfJgg$l `C $ u( *fJ/5(//+/+a|Jg.J(f(/5(a|//+a2.Hy{AaA  u *f/5//+/+aJg( S ,Sof// // a&SJf(TJf"C&f&.g4 CJg&Hy{n/(a>PJf"C i Ap+ C&fJg JfJfB/Hy{raF /././.// /./.aBa L 1:f 0:g p`, 0:f 1:f10m10nRnB$N^NuHV,O/"n . n".l"Bo$ 1:f 0:g10gB`Rnp$N^NuHV,O/ n"n $P Q/(/*a$nN^NuHV,OH8 n"n P(( Q&(Hx:/E0N$Hx:/N$@Jf/a$X`Jf/a"X`" l ///aLN^NuHV,OH8<*n$n &n(.A $J(f. /ab'(BXoA  sB,RnBoRA &I08 s8J,g8 p,/(N/ s8 p,/(/-N./-aJfRnfaA sJ,g "SlA  s!SmA s!,L<N^NuHV,OB/./././. /.aN^NuHV,OHx/./././. /.a\N^NuHV,O n". JgIf `RJfBN^NuHV,OH> $n(9&9 ,9`h "l2$Co$ *"҉ r Љ% % Rn䜂`*$Co"҉ r Љ% % Rn؂lm 9萹 ѹ# L|N^NuHV,O/ $n 9# #BHy{a# -f p#R`( +f BR`JgB`p# $nN^NuHV,OH?<*n ..B0JgJ4f,Jfp#// /.aH.p#4 Jg yJf y o # 9o #pf y g 9 g$/ aX` y g # .o*`R no 9 u -fJ(g# .g~Hy{ 9/5 aլPJfVR y g( 9 g / adX` y f ## # .f y g&#` 9 u -fJ(f(Jfp` 9# 0Rp`"9BJg u (-WIDRе#Jg 9 u (-g&JgJ(f(I//aNPJfIBBx&y`RJg =f$nB`Jf(J(`zRJg< K//9/an Jf$ /aJXf(J(|JgDJf@Jg" 9/5 /Hy{Hy(a/9aѹ`JgL&RJgJg R#0`JgX 9 u (-f//Hy{Hy(aȖ`*/ 9 u I//Hy{Hy(aj/9adѹ# p?`pfx no 9# 0R`VJg" 9/5 /Hy|(Hy(a/9aѹ# p? G :fdp:`^/9aѹJg n Jfv`Jg, 9 u (-g yI//a PJf|JgX 9 u (-f/9/Hy|NHy(a6`*/9 9 u I//Hy|nHy(a #nRBp?` yRI//al"@ yPJfRJg :fTJg>JgI//Hy|Hy(aƊ`I//Hy|Hy(anI#p?` WfP );fFIBBB yJg#0`V nfJg,Jg& * R! Rc") )Щ d$ Б"@XJf&(LN^NuNVH00&nJ g$k BJg /aHրXJf`/+a4&X'C$/aL-@/a@-@BBPp-@BJ g&$k Jg8HnHnHn/aJf`HnHnHn/+a/Hna*'@ &'nL N^NuHV,OH0 &.$y$`$jJgZJf / aXe涪dJf`< `:B"jc.$j Љ" rd"A` (Ш b$RbBL N^NuNVH8 n&n  &Hyn/E0NPJgHy}`/NPJg S zgB`n/a&$@RHy}`/a Jf'Z`BHk/ IbtNHk /aV$@B'@ S zfHn/ N$@ LN^NuNVH 8$n&n (n"nBgp?L,ё`@Jl&p?-@Hn/ a$@".L, -A`tgp?-@B3x`p/e |8 pN"`Bё`B0ё`"ӑ`Hn/ EbtNHn/N$@ .L, -@ .x .A! `Hn/ a$@ .B3x`lHn/ EbtNHn/N$@ .x .A! `8Hn/ EbtNHn/N$@7nt'n`Hn/ a$@7nt`Hn/ al$@'n`Hxa$Hx// a'B`$+Hx/ /aPO.a`r-ApeCxA .".pЁ!Rrd``Hn/ a$@'n `JHn/ EbtNHn/N$@ .L, -@ .x .A".D! `a4 LN^NuHV,O n !nBBB B!y$#$N^NuHV,O/$.Hxa//a$.N^NuHV,O . n !@!@ BBB!y$#$N^NuHV,O/$.Hxad//a$.N^NuHV,O/ .C$Jg* Qf$H"Jg /* an ` QCJfa:$nN^NuHV,O/.a/a($\H$ $2$$$$8 (d.L) )))%F)2-z" ($    __eh_frame__TEXTinstall-infoversionsectionremovequietiteminfo-fileinfo-dirhelpentrydir-filedelete%s: %s: warning: virtual memory exhausted for %s(none).gz.info.inf.info.gz Try `%s --help' for a complete list of options. Usage: %s [OPTION]... [INFO-FILE [DIR-FILE]] Install or delete dir entries from INFO-FILE in the Info directory file DIR-FILE. Options: --delete delete existing entries for INFO-FILE from DIR-FILE; don't insert any new entries. --dir-file=NAME specify file name of Info directory file. This is equivalent to using the DIR-FILE argument. --entry=TEXT insert TEXT as an Info directory entry. TEXT should have the form of an Info menu item line plus zero or more extra lines starting with whitespace. If you specify more than one entry, they are all added. If you don't specify any entries, they are determined from information in the Info file itself. --help display this help and exit. --info-file=FILE specify Info file to install in the directory. This is equivalent to using the INFO-FILE argument. --info-dir=DIR same as --dir-file=DIR/dir. --item=TEXT same as --entry TEXT. An Info directory entry is actually a menu item. --quiet suppress warnings. --remove same as --delete. --section=SEC put this file's entries in section SEC of the directory. If you specify more than one section, all the entries are added in each of the sections. If you don't specify any sections, they are determined from information in the Info file itself. --version display version information and exit. Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. wFile: dir, Node: TopThis is the file .../info/dir, which contains the topmost node of the Info hierarchy, called (dir)Top. The first time you invoke Info you start off looking at this node.  %s This is the top of the INFO tree This (the Directory node) gives a menu of major topics. Typing "q" exits, "?" lists all Info commands, "d" returns here, "h" gives a primer for first-timers, "mEmacs" visits the Emacs manual, etc. In Emacs, you can click mouse button 2 on a menu item or cross reference to select it. * Menu: %s: could not read (%s) and could not create (%s) r%s: empty filegzip -cd <>INFO-DIR-SECTION START-INFO-DIR-ENTRYMiscellaneousSTART-INFO-DIR-ENTRY without matching END-INFO-DIR-ENTRY* END-INFO-DIR-ENTRYEND-INFO-DIR-ENTRY without matching START-INFO-DIR-ENTRYNode:* Menu:i:d:e:s:hHr%s: Specify the Info directory only once. /dir %s: Specify the Info file only once. 4.1texinfoinstall-info (GNU %s) %s 2002Copyright (C) %s Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. excess command line argument `%s'No input file specified; try --help for more information.No dir file specified; try --help for more information.no info dir entry in `%s'menu item `%s' already exists, for file `%s'Topno entries found for `%s'; nothing deletedPOSIXLY_CORRECT--%s: option `%s' is ambiguous %s: option `--%s' doesn't allow an argument %s: option `%c%s' doesn't allow an argument %s: option `%s' requires an argument %s: unrecognized option `--%s' %s: unrecognized option `%c%s' %s: illegal option -- %c %s: invalid option -- %c %s: option requires an argument -- %c %s: option `-W %s' is ambiguous %s: option `-W %s' doesn't allow an argument ferror on stdoutfflush error on stdouteh=vNNPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzPzOPzPzPzOPzPzPzPzPzPzPzPzPzPzPzPzPzP:PzPzPzPzPzPzPzPzPzPzPzPzPzNOLPzPzOOPzPzPzPzPzPzPzPP Pihhhh(h0hriihii:hhiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiZiiln.nrn{dnuenphngDn]inXenRqnKrnCsn;Vnnnnn?./bin/texindex 755 0 0 60000 7444752436 6523 l8__PAGEZERO X__TEXT @@__text__TEXT2&__fvmlib_init0__TEXTY\P9\__fvmlib_init1__TEXTZ:__cstring__TEXTZ:__constructor__TEXT_2?2__const__TEXT_6?6__destructor__TEXT_?__eh_frame__TEXT_?__DATA` @ __data__DATA`@__bss__DATA`__common__DATA`8__LINKEDIT`07/usr/shlib/libsys_s.B.shlibX2 O .#`/H#`R/H#`aZJg yNJg yNJ8gaBJCgaat.aPNV-|Y\Nq Zd n"h n"P`N^NuHV,OHyZHyZHy a @Hy`/( a#N^NuNVH8 &.$. Be\Be$HyZBaddp#d#de e p#dp#d#e#e#e//aHyZHyZHyZa~/aV#eXB eLlE(BB yd/0La`& l yd/0LaXHn yd/0LaXPJg yd/0LaX0.@ @@fp# yd/0LaXHxB/NHxB/N$/a yeP 0Lf HyZHyZ yd/0La n// yd/0La `// yd/0La f ReLm/9e\aBaBLN^NuHV,OH0<&.GgG(/9` Hy[/ E%.NHy[/ NHx?Hx?Hy\/ N .\e/ NEPJ`gK`I%.SjJ+l D l k R`/ Hx a|PA A`Jg/0Hy\p/ a CA`$ 0f <Z/A$/5(Hy\u/ NA`(/0(Hy\{/ NRAJfT/ Hy\a/a\L< N^NuHV,OH<<*.(. vHy\E%N#e`Xf0Hy\N#e`XfHy\N#e`Xf #\e``"HyZHy\/9e`ar#e` Bd$/ENpN#d/N#eP*yd(@Po $<, D$p<R -fHyZ/ anPJfBHy\Hy]Hy] BNHyZaLHy] Hy]% BNBa>`Hy[/ G0NPJgHy[/ NPJf p#d`|Hy[/ G0NPJgHy[/ NPJfB`DHy[/ G0NPJgHy[/ NPJf DJ<gRePc)p<`HxaX`*Bn d#eLBJeLf HxaL<8$n&n J9dg"ed edtl<&.$. ,. BHha h*@*<BB/a$@Jl/Hy^/a tPG /Hs/ a Jo`( B3/ a4XJo \g @f\an#ed L< Q Ѐ#eHfp#eH 9eH/a #eD/ ///ah$f/Hy^a `B eD @A /a&Xg$C&yeDgF(<d$I/ /Hyda|%@ DJ(g//aj%@P XfHy9Hx eD//a$C&yeDg & f/aX`&Hy9DHx eD//9eDaXJgHy^-/aD*Pf /a vX/ eD//9eDa Jg /aX/9eDE%FN/ NL<|N^NuHV,OH08&n $n(JBgj \g @gB`\&`RJg  fgRX&9eH" йeDf$9eD#eH //a #eDrP` L N^NuHV,O/ / BeT#e,e(B9e,B9e-Be0pd#e8HxeGNpN#e4"9e8R/B/E)TNpd#e@HxeN#e<"9e@R/B/N$n&nN^NuNVH?<&. BBBB/.ad @ {f&HHka" S(X`"GPB.x. b.BBHx/.a -@/a-@f/.Hy^DaPBBHx/.E8&.*. ,./E08N&@/N(/N(@AHHta$//E0N/G(/ N./ NB4 L|N^NuHV,O/$.9%gHy^`HyaּXJgHy^Hy(atPJVID/aFNqHV,O//.a~$Xf Hy_aV $.N^NuHV,O/". . Jf/aH$X`//a޸$PJf Hy_ a $.N^NuHV,O/.Hy_Hy(a4a&NqHV,O//"nBBBp娆Jl^` n $&N^NuHV,O//"nBBBp娆^Jmpe gp娆 n $&N^NuHV,OH 8&n(n $,gD"+S T$p,Jg"S q (Jo Ђ# Sf Ђ S! Jf ,ѫLN^NuHV,OH80&n$. ga.Hk/ a +Ы PgaA"P&((g"S( Ѐ$`h Tc6$q q *Jo" q *Jo## Ѐ"T`$ q$q (Jo## Ѐ"R$Ԃ RbJfpdtS "<#<Bcn ЀTc6$q q *Jo" q *Jo## Ѐ"T`$ q$q (Jo## Ѐ"R ЀRbpezE/ / a6/a L N^NuHV,O nBJgJgJgR А @XJf N^NuHV,OH 8"n$n &n(n"$Jg>Jg,Jg& * R! Rc") )Щ d$ Б"@XJf&(LN^NuNVH00&nJ g$k BJg /aHրXJf`/+a4&X'C$/aֺ-@/a֮-@BBPp-@BJ g&$k Jg8HnHnHn/aJf`HnHnHn/+a/Hna*'@ &'nL N^NuHV,OH0 &.$y``$jJgZJf / aXe涪dJf`< `:B"jc.$j Љ" rd"A` (Ш b$RbBL N^NuNVH8 n&n  &HyZ/E0NPJgHy_./NPJg S zgB`n/aܔ$@RHy_./aP Jf'Z`BHk/ IONHk /aV$@B'@ S zfHn/ N$@ LN^NuNVH 8$n&n (n"nBgp?L,ё`@Jl&p?-@Hn/ a$@".L, -A`tgp?-@B3x`p/e |_6 pN"`Bё`B0ё`"ӑ`Hn/ EONHn/N$@ .L, -@ .x .A! `Hn/ a$@ .B3x`lHn/ EONHn/N$@ .x .A! `8Hn/ EONHn/N$@7nt'n`Hn/ a$@7nt`Hn/ al$@'n`HxaJ$Hx// a'B`$+Hx/ /aPO.ab`r-ApeCxA .".pЁ!Rrd``Hn/ a$@'n `JHn/ EONHn/N$@ .L, -@ .x .A".D! `aʢ LN^NuHV,O n !nBBB B!y`#`N^NuHV,O/$.Hxa(//a$.N^NuHV,O . n !@!@ BBB!y`#`N^NuHV,O/$.Hxa//a$.N^NuHV,O/ .C`Jg* Qf$H"Jg /* a ` QCJfaɨ$nN^NuHV,O/.a/aͪN^NuNVLH< (.*. /a$@XJgHn/ a$PfB`HxHnVaP=n-nZ *Y J&XcBHnHnV/a$btԊ n zfHnR/a$ԮRP В&X-jN`HnNHnHnV/a$cNdHx/HnVa> L<8N^NuHV,OH0<*n&n &-r 刟(OBc@`, U"p,$p )j + S! R UB"4pf),"RbBBc UJ,g!,RRb+AL< N^NuHV,OHyZHyZHy aʹ @/( aN^Nu 3,d=jT=dP=^D=X@=R<$P8$J420$V,$D$,$&$ $>($\H$ $2$$$$8 (d.`L`) )))%F)2-z" ($`    __eh_frame__TEXTtexindextxiXXXXXXsdisplay version information and exit--versionsend output to FILEFILE-o--outputdo not keep temporary files around after processing (default)--no-keepkeep temporary files around after processing-k--keepdisplay this help and exit-h--helpUsage: %s [OPTION]... FILE... Generate a sorted index for each TeX output FILE. Usually FILE... is specified as `foo.%c%c' for a document `foo.texi'. Options: %s, %s %s %s Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. TMPDIRTEMPTMP/tmp//4.1texinfotexindex (GNU %s) %s 2002Copyright (C) %s Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. .%dr%s: not a texinfo index filewfailure reopening %sNo page number in %s} \initial {\entry {\primary {}{entry %s follows an entry with a secondary name\secondary {, %s: %s; for file `%s'. ferror on stdoutfflush error on stdoutxmallocxrealloc%s: Out of virtual memory! eh3bVTTTTTUVVUUUURUzUVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVUV(V>Y0Z[[[[[d[p[fd[([[[[ZZ./bin/texi2dvi 755 0 0 52420 7444752436 6440 #! /bin/sh # texi2dvi --- produce DVI (or PDF) files from Texinfo (or LaTeX) sources. # $Id: texi2dvi,v 0.47 2002/03/04 16:50:32 karl Exp $ # # Copyright (C) 1992, 93, 94, 95, 96, 97, 98, 99, 2001, 02 # Free Software Foundation, Inc. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2, or (at your option) # any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, you can either send email to this # program's maintainer or write to: The Free Software Foundation, # Inc.; 59 Temple Place, Suite 330; Boston, MA 02111-1307, USA. # # Original author: Noah Friedman . # # Please send bug reports, etc. to bug-texinfo@gnu.org. # If possible, please send a copy of the output of the script called with # the `--debug' option when making a bug report. # This string is expanded by rcs automatically when this file is checked out. rcs_revision='$Revision: 0.47 $' rcs_version=`set - $rcs_revision; echo $2` program=`echo $0 | sed -e 's!.*/!!'` version="texi2dvi (GNU Texinfo 4.1) $rcs_version Copyright (C) 2002 Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING." usage="Usage: $program [OPTION]... FILE... Run each Texinfo or LaTeX FILE through TeX in turn until all cross-references are resolved, building all indices. The directory containing each FILE is searched for included files. The suffix of FILE is used to determine its language (LaTeX or Texinfo). Makeinfo is used to perform Texinfo macro expansion before running TeX when needed. Operation modes: -b, --batch no interaction -c, --clean remove all auxiliary files -D, --debug turn on shell debugging (set -x) -h, --help display this help and exit successfully -o, --output=OFILE leave output in OFILE (implies --clean); Only one input FILE may be specified in this case -q, --quiet no output unless errors (implies --batch) -s, --silent same as --quiet -v, --version display version information and exit successfully -V, --verbose report on what is done TeX tuning: -@ use @input instead of \input; for preloaded Texinfo -e, --expand force macro expansion using makeinfo -I DIR search DIR for Texinfo files -l, --language=LANG specify the LANG of FILE (LaTeX or Texinfo) -p, --pdf use pdftex or pdflatex for processing -t, --texinfo=CMD insert CMD after @setfilename in copy of input file multiple values accumulate The values of the BIBTEX, LATEX (or PDFLATEX), MAKEINDEX, MAKEINFO, TEX (or PDFTEX), and TEXINDEX environment variables are used to run those commands, if they are set. Email bug reports to , general questions and discussion to ." # Initialize variables for option overriding and otherwise. # Don't use `unset' since old bourne shells don't have this command. # Instead, assign them an empty value. batch=false # eval for batch mode clean= debug= escape='\' expand= # t for expansion via makeinfo miincludes= # makeinfo include path oformat=dvi oname= # --output quiet= # by default let the tools' message be displayed set_language= textra= tmpdir=${TMPDIR:-/tmp}/t2d$$ # avoid collisions on 8.3 filesystems. txincludes= # TEXINPUTS extensions txiprereq=19990129 # minimum texinfo.tex version to have macro expansion verbose=false # echo for verbose mode orig_pwd=`pwd` # Systems which define $COMSPEC or $ComSpec use semicolons to separate # directories in TEXINPUTS. if test -n "$COMSPEC$ComSpec"; then path_sep=";" else path_sep=":" fi # Save this so we can construct a new TEXINPUTS path for each file. TEXINPUTS_orig="$TEXINPUTS" # Unfortunately makeindex does not read TEXINPUTS. INDEXSTYLE_orig="$INDEXSTYLE" export TEXINPUTS INDEXSTYLE # Push a token among the arguments that will be used to notice when we # ended options/arguments parsing. # Use "set dummy ...; shift" rather than 'set - ..." because on # Solaris set - turns off set -x (but keeps set -e). # Use ${1+"$@"} rather than "$@" because Digital Unix and Ultrix 4.3 # still expand "$@" to a single argument (the empty string) rather # than nothing at all. arg_sep="$$--$$" set dummy ${1+"$@"} "$arg_sep"; shift # # Parse command line arguments. while test x"$1" != x"$arg_sep"; do # Handle --option=value by splitting apart and putting back on argv. case "$1" in --*=*) opt=`echo "$1" | sed -e 's/=.*//'` val=`echo "$1" | sed -e 's/[^=]*=//'` shift set dummy "$opt" "$val" ${1+"$@"}; shift ;; esac # This recognizes --quark as --quiet. So what. case "$1" in -@ ) escape=@;; # Silently and without documentation accept -b and --b[atch] as synonyms. -b | --b*) batch=eval;; -q | -s | --q* | --s*) quiet=t; batch=eval;; -c | --c*) clean=t;; -D | --d*) debug=t;; -e | --e*) expand=t;; -h | --h*) echo "$usage"; exit 0;; -I | --I*) shift miincludes="$miincludes -I $1" txincludes="$txincludes$path_sep$1" ;; -l | --l*) shift; set_language=$1;; -o | --o*) shift clean=t case "$1" in /* | ?:/*) oname=$1;; *) oname="$orig_pwd/$1";; esac;; -p | --p*) oformat=pdf;; -t | --t*) shift; textra="$textra\\ $1";; -v | --vers*) echo "$version"; exit 0;; -V | --verb*) verbose=echo;; --) # What remains are not options. shift while test x"$1" != x"$arg_sep"; do set dummy ${1+"$@"} "$1"; shift shift done break;; -*) echo "$0: Unknown or ambiguous option \`$1'." >&2 echo "$0: Try \`--help' for more information." >&2 exit 1;; *) set dummy ${1+"$@"} "$1"; shift;; esac shift done # Pop the token shift # Interpret remaining command line args as filenames. case $# in 0) echo "$0: Missing file arguments." >&2 echo "$0: Try \`--help' for more information." >&2 exit 2 ;; 1) ;; *) if test -n "$oname"; then echo "$0: Can't use option \`--output' with more than one argument." >&2 exit 2 fi ;; esac # Prepare the temporary directory. Remove it at exit, unless debugging. if test -z "$debug"; then trap "cd / && rm -rf $tmpdir" 0 1 2 15 fi # Create the temporary directory with strict rights (umask 077 && mkdir $tmpdir) || exit 1 # Prepare the tools we might need. This may be extra work in some # cases, but improves the readibility of the script. utildir=$tmpdir/utils mkdir $utildir || exit 1 # A sed script that preprocesses Texinfo sources in order to keep the # iftex sections only. We want to remove non TeX sections, and # comment (with `@c texi2dvi') TeX sections so that makeinfo does not # try to parse them. Nevertheless, while commenting TeX sections, # don't comment @macro/@end macro so that makeinfo does propagate # them. Unfortunately makeinfo --iftex --no-ifhtml --no-ifinfo # doesn't work well enough (yet) to use that, so work around with sed. comment_iftex_sed=$utildir/comment.sed cat <$comment_iftex_sed /^@tex/,/^@end tex/{ s/^/@c texi2dvi/ } /^@iftex/,/^@end iftex/{ s/^/@c texi2dvi/ /^@c texi2dvi@macro/,/^@c texi2dvi@end macro/{ s/^@c texi2dvi// } } /^@html/,/^@end html/{ s/^/@c (texi2dvi)/ } /^@ifhtml/,/^@end ifhtml/{ s/^/@c (texi2dvi)/ } /^@ifnottex/,/^@end ifnottex/{ s/^/@c (texi2dvi)/ } /^@ifinfo/,/^@end ifinfo/{ /^@node/p /^@menu/,/^@end menu/p t s/^/@c (texi2dvi)/ } s/^@ifnotinfo/@c texi2dvi@ifnotinfo/ s/^@end ifnotinfo/@c texi2dvi@end ifnotinfo/ EOF # Uncommenting is simple: Remove any leading `@c texi2dvi'. uncomment_iftex_sed=$utildir/uncomment.sed cat <$uncomment_iftex_sed s/^@c texi2dvi// EOF # A shell script that computes the list of xref files. # Takes the filename (without extension) of which we look for xref # files as argument. The index files must be reported last. get_xref_files=$utildir/get_xref.sh cat <<\EOF >$get_xref_files #! /bin/sh # Get list of xref files (indexes, tables and lists). # Find all files having root filename with a two-letter extension, # saves the ones that are really Texinfo-related files. .?o? catches # LaTeX tables and lists. for this_file in "$1".?o? "$1".aux "$1".?? "$1".idx; do # If file is empty, skip it. test -s "$this_file" || continue # If the file is not suitable to be an index or xref file, don't # process it. The file can't be if its first character is not a # backslash or single quote. first_character=`sed -n '1s/^\(.\).*$/\1/p;q' $this_file` if test "x$first_character" = "x\\" \ || test "x$first_character" = "x'"; then xref_files="$xref_files ./$this_file" fi done echo "$xref_files" EOF chmod 500 $get_xref_files # File descriptor usage: # 0 standard input # 1 standard output (--verbose messages) # 2 standard error # 3 some systems may open it to /dev/tty # 4 used on the Kubota Titan # 5 tools output (turned off by --quiet) # Tools' output. If quiet, discard, else redirect to the message flow. if test "$quiet" = t; then exec 5>/dev/null else exec 5>&1 fi # Enable tracing test "$debug" = t && set -x # # TeXify files. for command_line_filename in ${1+"$@"}; do $verbose "Processing $command_line_filename ..." # If the COMMAND_LINE_FILENAME is not absolute (e.g., --debug.tex), # prepend `./' in order to avoid that the tools take it as an option. echo "$command_line_filename" | egrep '^(/|[A-z]:/)' >/dev/null \ || command_line_filename="./$command_line_filename" # See if the file exists. If it doesn't we're in trouble since, even # though the user may be able to reenter a valid filename at the tex # prompt (assuming they're attending the terminal), this script won't # be able to find the right xref files and so forth. if test ! -r "$command_line_filename"; then echo "$0: Could not read $command_line_filename, skipping." >&2 continue fi # Get the name of the current directory. We want the full path # because in clean mode we are in tmp, in which case a relative # path has no meaning. filename_dir=`echo $command_line_filename | sed 's!/[^/]*$!!;s!^$!.!'` filename_dir=`cd "$filename_dir" >/dev/null && pwd` # Strip directory part but leave extension. filename_ext=`basename "$command_line_filename"` # Strip extension. filename_noext=`echo "$filename_ext" | sed 's/\.[^.]*$//'` ext=`echo "$filename_ext" | sed 's/^.*\.//'` # _src. Use same basename since we want to generate aux files with # the same basename as the manual. If --expand, then output the # macro-expanded file to here, else copy the original file. tmpdir_src=$tmpdir/src filename_src=$tmpdir_src/$filename_noext.$ext # _xtr. The file with the user's extra commands. tmpdir_xtr=$tmpdir/xtr filename_xtr=$tmpdir_xtr/$filename_noext.$ext # _bak. Copies of the previous xref files (another round is run if # they differ from the new one). tmpdir_bak=$tmpdir/bak # Make all those directories and give up if we can't succeed. mkdir $tmpdir_src $tmpdir_xtr $tmpdir_bak || exit 1 # Source file might include additional sources. Put `.' and # directory where source file(s) reside in TEXINPUTS before anything # else. `.' goes first to ensure that any old .aux, .cps, # etc. files in ${directory} don't get used in preference to fresher # files in `.'. Include orig_pwd in case we are in clean mode, where # we've cd'd to a temp directory. common=".$path_sep$orig_pwd$path_sep$filename_dir$path_sep$txincludes$path_sep" TEXINPUTS="$common$TEXINPUTS_orig" INDEXSTYLE="$common$INDEXSTYLE_orig" # If the user explicitly specified the language, use that. # Otherwise, if the first line is \input texinfo, assume it's texinfo. # Otherwise, guess from the file extension. if test -n "$set_language"; then language=$set_language elif sed 1q "$command_line_filename" | fgrep 'input texinfo' >/dev/null; then language=texinfo else language= fi # Get the type of the file (latex or texinfo) from the given language # we just guessed, or from the file extension if not set yet. case ${language:-$filename_ext} in [lL]a[tT]e[xX] | *.ltx | *.tex) # Assume a LaTeX file. LaTeX needs bibtex and uses latex for # compilation. No makeinfo. bibtex=${BIBTEX:-bibtex} makeinfo= # no point in running makeinfo on latex source. texindex=${MAKEINDEX:-makeindex} if test $oformat = dvi; then tex=${LATEX:-latex} else tex=${PDFLATEX:-pdflatex} fi ;; *) # Assume a Texinfo file. Texinfo files need makeinfo, texindex and tex. bibtex= texindex=${TEXINDEX:-texindex} if test $oformat = dvi; then tex=${TEX:-tex} else tex=${PDFTEX:-pdftex} fi # Unless required by the user, makeinfo expansion is wanted only # if texinfo.tex is too old. if test "$expand" = t; then makeinfo=${MAKEINFO:-makeinfo} else # Check if texinfo.tex performs macro expansion by looking for # its version. The version is a date of the form YEAR-MO-DA. # We don't need to use [0-9] to match the digits since anyway # the comparison with $txiprereq, a number, will fail with non # digits. txiversion_tex=txiversion.tex echo '\input texinfo.tex @bye' >$tmpdir/$txiversion_tex # Run in the tmpdir to avoid leaving files. eval `cd $tmpdir >/dev/null && $tex $txiversion_tex 2>/dev/null | sed -n 's/^.*\[\(.*\)version \(....\)-\(..\)-\(..\).*$/txiformat=\1 txiversion="\2\3\4"/p'` $verbose "texinfo.tex preloaded as \`$txiformat', version is \`$txiversion' ..." if test "$txiprereq" -le "$txiversion" >/dev/null 2>&1; then makeinfo= else makeinfo=${MAKEINFO:-makeinfo} fi # As long as we had to run TeX, offer the user this convenience if test "$txiformat" = Texinfo; then escape=@ fi fi ;; esac # Expand macro commands in the original source file using Makeinfo. # Always use `end' footnote style, since the `separate' style # generates different output (arguably this is a bug in -E). # Discard main info output, the user asked to run TeX, not makeinfo. if test -n "$makeinfo"; then $verbose "Macro-expanding $command_line_filename to $filename_src ..." sed -f $comment_iftex_sed "$command_line_filename" \ | $makeinfo --footnote-style=end -I "$filename_dir" $miincludes \ -o /dev/null --macro-expand=- \ | sed -f $uncomment_iftex_sed >"$filename_src" filename_input=$filename_src fi # If makeinfo failed (or was not even run), use the original file as input. if test $? -ne 0 \ || test ! -r "$filename_src"; then $verbose "Reverting to $command_line_filename ..." filename_input=$filename_dir/$filename_ext fi # Used most commonly for @finalout, @smallbook, etc. if test -n "$textra"; then $verbose "Inserting extra commands: $textra" sed '/^@setfilename/a\ '"$textra" "$filename_input" >$filename_xtr filename_input=$filename_xtr fi # If clean mode was specified, then move to the temporary directory. if test "$clean" = t; then $verbose "cd $tmpdir_src" cd "$tmpdir_src" || exit 1 fi while :; do # will break out of loop below orig_xref_files=`$get_xref_files "$filename_noext"` # Save copies of originals for later comparison. if test -n "$orig_xref_files"; then $verbose "Backing up xref files: `echo $orig_xref_files | sed 's|\./||g'`" cp $orig_xref_files $tmpdir_bak fi # Run bibtex on current file. # - If its input (AUX) exists. # - If AUX contains both `\bibdata' and `\bibstyle'. # - If some citations are missing (LOG contains `Citation'). # or the LOG complains of a missing .bbl # # We run bibtex first, because I can see reasons for the indexes # to change after bibtex is run, but I see no reason for the # converse. # # Don't try to be too smart. Running bibtex only if the bbl file # exists and is older than the LaTeX file is wrong, since the # document might include files that have changed. Because there # can be several AUX (if there are \include's), but a single LOG, # looking for missing citations in LOG is easier, though we take # the risk to match false messages. if test -n "$bibtex" \ && test -r "$filename_noext.aux" \ && test -r "$filename_noext.log" \ && (grep '^\\bibdata[{]' "$filename_noext.aux" \ && grep '^\\bibstyle[{]' "$filename_noext.aux" \ && (grep 'Warning:.*Citation.*undefined' "$filename_noext.log" \ || grep 'No file .*\.bbl\.' "$filename_noext.log")) \ >/dev/null 2>&1; \ then $verbose "Running $bibtex $filename_noext ..." if $bibtex "$filename_noext" >&5; then :; else echo "$0: $bibtex exited with bad status, quitting." >&2 exit 1 fi fi # What we'll run texindex on -- exclude non-index files. # Since we know index files are last, it is correct to remove everything # before .aux and .?o?. index_files=`echo "$orig_xref_files" \ | sed "s!.*\.aux!!g; s!./$filename_noext\..o.!!g; s/^[ ]*//;s/[ ]*$//"` # Run texindex (or makeindex) on current index files. If they # already exist, and after running TeX a first time the index # files don't change, then there's no reason to run TeX again. # But we won't know that if the index files are out of date or # nonexistent. if test -n "$texindex" && test -n "$index_files"; then $verbose "Running $texindex $index_files ..." if $texindex $index_files 2>&5 1>&2; then :; else echo "$0: $texindex exited with bad status, quitting." >&2 exit 1 fi fi # Finally, run TeX. # Prevent $ESCAPE from being interpreted by the shell if it happens # to be `/'. $batch tex_args="\\${escape}nonstopmode\ \\${escape}input" $verbose "Running $cmd ..." cmd="$tex $tex_args $filename_input" if $cmd >&5; then :; else echo "$0: $tex exited with bad status, quitting." >&2 echo "$0: see $filename_noext.log for errors." >&2 test "$clean" = t \ && cp "$filename_noext.log" "$orig_pwd" exit 1 fi # Decide if looping again is needed. finished=t # LaTeX (and the package changebar) report in the LOG file if it # should be rerun. This is needed for files included from # subdirs, since texi2dvi does not try to compare xref files in # subdirs. Performing xref files test is still good since LaTeX # does not report changes in xref files. if fgrep "Rerun to get" "$filename_noext.log" >/dev/null 2>&1; then finished= fi # Check if xref files changed. new_xref_files=`$get_xref_files "$filename_noext"` $verbose "Original xref files = `echo $orig_xref_files | sed 's|\./||g'`" $verbose "New xref files = `echo $new_xref_files | sed 's|\./||g'`" # If old and new lists don't at least have the same file list, # then one file or another has definitely changed. test "x$orig_xref_files" != "x$new_xref_files" && finished= # File list is the same. We must compare each file until we find # a difference. if test -n "$finished"; then for this_file in $new_xref_files; do $verbose "Comparing xref file `echo $this_file | sed 's|\./||g'` ..." # cmp -s returns nonzero exit status if files differ. if cmp -s "$this_file" "$tmpdir_bak/$this_file"; then :; else # We only need to keep comparing until we find one that # differs, because we'll have to run texindex & tex again no # matter how many more there might be. finished= $verbose "xref file `echo $this_file | sed 's|\./||g'` differed ..." test "$debug" = t && diff -c "$tmpdir_bak/$this_file" "$this_file" break fi done fi # If finished, exit the loop, else rerun the loop. test -n "$finished" && break done # If we were in clean mode, compilation was in a tmp directory. # Copy the DVI (or PDF) file into the directory where the compilation # has been done. (The temp dir is about to get removed anyway.) # We also return to the original directory so that # - the next file is processed in correct conditions # - the temporary file can be removed if test -n "$clean"; then if test -n "$oname"; then dest=$oname else dest=$orig_pwd fi $verbose "Copying $oformat file from `pwd` to $dest" cp -p "./$filename_noext.$oformat" "$dest" cd / # in case $orig_pwd is on a different drive (for DOS) cd $orig_pwd || exit 1 fi # Remove temporary files. if test "x$debug" = "x"; then $verbose "Removing $tmpdir_src $tmpdir_xtr $tmpdir_bak ..." cd / rm -rf $tmpdir_src $tmpdir_xtr $tmpdir_bak fi done $verbose "$0 done." exit 0 # exit successfully, not however we ended the loop. lse # Check if texinfo.tex performs macro expansion by looking for # its version. The version is a date of the form YEAR-MO-DA. # We don't need to use [0-9] to match the digits since anyway # the comparison ./share/ 755 0 0 0 7442532615 5167 ./share/texinfo/ 755 0 0 0 7442532616 6644 ./share/texinfo/texinfo.dtd 644 0 0 24405 7442526223 11124 # What we'll run texindex on -- exclude non-index files. # Since we know index files are last, it is correct to remove everything # before .aux and .?o?. index_files=`echo "$orig_xref_files" \ | sed "s!.*\.aux!!g; ./share/texinfo/texinfo.xsl 644 0 0 11144 7442526223 11153 <xsl:apply-templates select="TEXINFO/SETTITLE" mode="head"/>

      Footnotes

      [ Previous: # ] [ Up: # ] [ Next: # ]

      Menu

       # : 

      •
      • | xrefprintedname | xrefprinteddesc)*> &5; then :; else echo "$0: $tex exited with bad status, quitting." >&2 echo "$0: see $filename_noext.log./info/texinfo-1 644 0 0 137516 7442531460 6714 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Top, Next: Copying, Up: (dir) Texinfo ******* Texinfo is a documentation system that uses a single source to produce both online information and printed output. The first part of this master menu lists the major nodes in this Info document, including the @-command and concept indices. The rest of the menu lists all the lower level nodes in the document. This is Edition 4.1 of the Texinfo manual, updated 4 March 2002. * Menu: * Copying:: Your rights. * Overview:: Texinfo in brief. * Texinfo Mode:: How to use Texinfo mode. * Beginning a File:: What is at the beginning of a Texinfo file? * Ending a File:: What is at the end of a Texinfo file? * Structuring:: How to create chapters, sections, subsections, appendices, and other parts. * Nodes:: How to write nodes. * Menus:: How to write menus. * Cross References:: How to write cross references. * Marking Text:: How to mark words and phrases as code, keyboard input, meta-syntactic variables, and the like. * Quotations and Examples:: How to write quotations, examples, etc. * Lists and Tables:: How to write lists and tables. * Indices:: How to create indices. * Insertions:: How to insert @-signs, braces, etc. * Breaks:: How to force and prevent line and page breaks. * Definition Commands:: How to describe functions and the like in a uniform manner. * Conditionals:: How to specify text for either TeX or Info. * Internationalization:: * Defining New Texinfo Commands:: * Hardcopy:: How to convert a Texinfo file to a file for printing and how to print that file. * Creating and Installing Info Files:: * Command List:: All the Texinfo @-commands. * Tips:: Hints on how to write a Texinfo document. * Sample Texinfo File:: A sample Texinfo file to look at. * Include Files:: How to incorporate other Texinfo files. * Headings:: How to write page headings and footings. * Catching Mistakes:: How to find formatting mistakes. * Refilling Paragraphs:: All about paragraph refilling. * Command Syntax:: A description of @-Command syntax. * Obtaining TeX:: How to Obtain TeX. * Documentation Copying:: The GNU Free Documentation License. * Command and Variable Index:: A menu containing commands and variables. * Concept Index:: A menu covering many topics. --- The Detailed Node Listing --- Overview of Texinfo * Reporting Bugs:: Submitting effective bug reports. * Using Texinfo:: Create printed or online output. * Info Files:: What is an Info file? * Printed Books:: Characteristics of a printed book or manual. * Formatting Commands:: @-commands are used for formatting. * Conventions:: General rules for writing a Texinfo file. * Comments:: Writing comments and ignored text in general. * Minimum:: What a Texinfo file must have. * Six Parts:: Usually, a Texinfo file has six parts. * Short Sample:: A short sample Texinfo file. * History:: Acknowledgements, contributors and genesis. Using Texinfo Mode * Texinfo Mode Overview:: How Texinfo mode can help you. * Emacs Editing:: Texinfo mode adds to GNU Emacs' general purpose editing features. * Inserting:: How to insert frequently used @-commands. * Showing the Structure:: How to show the structure of a file. * Updating Nodes and Menus:: How to update or create new nodes and menus. * Info Formatting:: How to format for Info. * Printing:: How to format and print part or all of a file. * Texinfo Mode Summary:: Summary of all the Texinfo mode commands. Updating Nodes and Menus * Updating Commands:: Five major updating commands. * Updating Requirements:: How to structure a Texinfo file for using the updating command. * Other Updating Commands:: How to indent descriptions, insert missing nodes lines, and update nodes in sequence. Beginning a Texinfo File * Four Parts:: Four parts begin a Texinfo file. * Sample Beginning:: Here is a sample beginning for a Texinfo file. * Header:: The very beginning of a Texinfo file. * Info Summary and Permissions:: Summary and copying permissions for Info. * Titlepage & Copyright Page:: Creating the title and copyright pages. * The Top Node:: Creating the `Top' node and master menu. * Software Copying Permissions:: Ensure that you and others continue to have the right to use and share software. The Texinfo File Header * First Line:: The first line of a Texinfo file. * Start of Header:: Formatting a region requires this. * setfilename:: Tell Info the name of the Info file. * settitle:: Create a title for the printed work. * documentdescription:: Document summary for the HTML output. * setchapternewpage:: Start chapters on right-hand pages. * paragraphindent:: Specify paragraph indentation. * exampleindent:: Specify environment indentation. * End of Header:: Formatting a region requires this. The Title and Copyright Pages * titlepage:: Create a title for the printed document. * titlefont center sp:: The `@titlefont', `@center', and `@sp' commands. * title subtitle author:: The `@title', `@subtitle', and `@author' commands. * Copyright & Permissions:: How to write the copyright notice and include copying permissions. * end titlepage:: Turn on page headings after the title and copyright pages. * headings on off:: An option for turning headings on and off and double or single sided printing. The `Top' Node and Master Menu * Title of Top Node:: Sketch what the file is about. * Master Menu Parts:: A master menu has three or more parts. Ending a Texinfo File * Printing Indices & Menus:: How to print an index in hardcopy and generate index menus in Info. * Contents:: How to create a table of contents. * File End:: How to mark the end of a file. Chapter Structuring * Tree Structuring:: A manual is like an upside down tree ... * Structuring Command Types:: How to divide a manual into parts. * makeinfo top:: The `@top' command, part of the `Top' node. * chapter:: * unnumbered & appendix:: * majorheading & chapheading:: * section:: * unnumberedsec appendixsec heading:: * subsection:: * unnumberedsubsec appendixsubsec subheading:: * subsubsection:: Commands for the lowest level sections. * Raise/lower sections:: How to change commands' hierarchical level. Nodes * Two Paths:: Different commands to structure Info output and printed output. * Node Menu Illustration:: A diagram, and sample nodes and menus. * node:: Creating nodes, in detail. * makeinfo Pointer Creation:: Letting makeinfo determine node pointers. * anchor:: Defining arbitrary cross-reference targets. The `@node' Command * Node Names:: How to choose node and pointer names. * Writing a Node:: How to write an `@node' line. * Node Line Tips:: Keep names short. * Node Line Requirements:: Keep names unique, without @-commands. * First Node:: How to write a `Top' node. * makeinfo top command:: How to use the `@top' command. * Top Node Summary:: Write a brief description for readers. Menus * Menu Location:: Put a menu in a short node. * Writing a Menu:: What is a menu? * Menu Parts:: A menu entry has three parts. * Less Cluttered Menu Entry:: Two part menu entry. * Menu Example:: Two and three part menu entries. * Other Info Files:: How to refer to a different Info file. Cross References * References:: What cross references are for. * Cross Reference Commands:: A summary of the different commands. * Cross Reference Parts:: A cross reference has several parts. * xref:: Begin a reference with `See' ... * Top Node Naming:: How to refer to the beginning of another file. * ref:: A reference for the last part of a sentence. * pxref:: How to write a parenthetical cross reference. * inforef:: How to refer to an Info-only file. * uref:: How to refer to a uniform resource locator. `@xref' * Reference Syntax:: What a reference looks like and requires. * One Argument:: `@xref' with one argument. * Two Arguments:: `@xref' with two arguments. * Three Arguments:: `@xref' with three arguments. * Four and Five Arguments:: `@xref' with four and five arguments. Marking Words and Phrases * Indicating:: How to indicate definitions, files, etc. * Emphasis:: How to emphasize text. Indicating Definitions, Commands, etc. * Useful Highlighting:: Highlighting provides useful information. * code:: Indicating program code. * kbd:: Showing keyboard input. * key:: Specifying keys. * samp:: A literal sequence of characters. * verb:: A verbatim sequence of characters. * var:: Indicating metasyntactic variables. * env:: Indicating environment variables. * file:: Indicating file names. * command:: Indicating command names. * option:: Indicating option names. * dfn:: Specifying definitions. * cite:: Referring to books not in the Info system. * acronym:: Indicating acronyms. * url:: Indicating a World Wide Web reference. * email:: Indicating an electronic mail address. Emphasizing Text * emph & strong:: How to emphasize text in Texinfo. * Smallcaps:: How to use the small caps font. * Fonts:: Various font commands for printed output. Quotations and Examples * Block Enclosing Commands:: Different constructs for different purposes. * quotation:: Writing a quotation. * example:: Writing an example in a fixed-width font. * verbatim:: Writing a verbatim example. * verbatiminclude:: Including a file verbatim. * lisp:: Illustrating Lisp code. * small:: Forms for `@smallbook'. * display:: Writing an example in the current font. * format:: Writing an example without narrowed margins. * exdent:: Undo indentation on a line. * flushleft & flushright:: Pushing text flush left or flush right. * noindent:: Preventing paragraph indentation. * cartouche:: Drawing rounded rectangles around examples. Lists and Tables * Introducing Lists:: Texinfo formats lists for you. * itemize:: How to construct a simple list. * enumerate:: How to construct a numbered list. * Two-column Tables:: How to construct a two-column table. * Multi-column Tables:: How to construct generalized tables. Making a Two-column Table * table:: How to construct a two-column table. * ftable vtable:: Automatic indexing for two-column tables. * itemx:: How to put more entries in the first column. Multi-column Tables * Multitable Column Widths:: Defining multitable column widths. * Multitable Rows:: Defining multitable rows, with examples. Indices * Index Entries:: Choose different words for index entries. * Predefined Indices:: Use different indices for different kinds of entry. * Indexing Commands:: How to make an index entry. * Combining Indices:: How to combine indices. * New Indices:: How to define your own indices. Combining Indices * syncodeindex:: How to merge two indices, using `@code' font for the merged-from index. * synindex:: How to merge two indices, using the default font of the merged-to index. Special Insertions * Braces Atsigns:: How to insert braces, `@'. * Inserting Space:: How to insert the right amount of space within a sentence. * Inserting Accents:: How to insert accents and special characters. * Dots Bullets:: How to insert dots and bullets. * TeX and copyright:: How to insert the TeX logo and the copyright symbol. * pounds:: How to insert the pounds currency symbol. * minus:: How to insert a minus sign. * math:: How to format a mathematical expression. * Glyphs:: How to indicate results of evaluation, expansion of macros, errors, etc. * Footnotes:: How to include footnotes. * Images:: How to include graphics. Inserting @ and Braces * Inserting An Atsign:: How to insert `@'. * Inserting Braces:: How to insert `{' and `}'. Inserting Space * Not Ending a Sentence:: Sometimes a . doesn't end a sentence. * Ending a Sentence:: Sometimes it does. * Multiple Spaces:: Inserting multiple spaces. * dmn:: How to format a dimension. Inserting Ellipsis and Bullets * dots:: How to insert dots ... * bullet:: How to insert a bullet. Inserting TeX and the Copyright Symbol * tex:: How to insert the TeX logo. * copyright symbol:: How to use `@copyright'{}. Glyphs for Examples * Glyphs Summary:: * result:: How to show the result of expression. * expansion:: How to indicate an expansion. * Print Glyph:: How to indicate printed output. * Error Glyph:: How to indicate an error message. * Equivalence:: How to indicate equivalence. * Point Glyph:: How to indicate the location of point. Glyphs Summary * result:: * expansion:: * Print Glyph:: * Error Glyph:: * Equivalence:: * Point Glyph:: Footnotes * Footnote Commands:: How to write a footnote in Texinfo. * Footnote Styles:: Controlling how footnotes appear in Info. Making and Preventing Breaks * Break Commands:: Cause and prevent splits. * Line Breaks:: How to force a single line to use two lines. * - and hyphenation:: How to tell TeX about hyphenation points. * w:: How to prevent unwanted line breaks. * sp:: How to insert blank lines. * page:: How to force the start of a new page. * group:: How to prevent unwanted page breaks. * need:: Another way to prevent unwanted page breaks. Definition Commands * Def Cmd Template:: How to structure a description using a definition command. * Optional Arguments:: How to handle optional and repeated arguments. * deffnx:: How to group two or more `first' lines. * Def Cmds in Detail:: All the definition commands. * Def Cmd Conventions:: Conventions for writing definitions. * Sample Function Definition:: The Definition Commands * Functions Commands:: Commands for functions and similar entities. * Variables Commands:: Commands for variables and similar entities. * Typed Functions:: Commands for functions in typed languages. * Typed Variables:: Commands for variables in typed languages. * Abstract Objects:: Commands for object-oriented programming. * Data Types:: The definition command for data types. Conditionally Visible Text * Conditional Commands:: Specifying text for HTML, Info, or TeX. * Conditional Not Commands:: Specifying text for not HTML, Info, or TeX. * Raw Formatter Commands:: Using raw TeX or HTML commands. * set clear value:: Designating which text to format (for all output formats); and how to set a flag to a string that you can insert. `@set', `@clear', and `@value' * set value:: Expand a flag variable to a string. * ifset ifclear:: Format a region if a flag is set. * value Example:: An easy way to update edition information. Internationalization * documentlanguage:: Declaring the current language. * documentencoding:: Declaring the input encoding. Defining New Texinfo Commands * Defining Macros:: Defining and undefining new commands. * Invoking Macros:: Using a macro, once you've defined it. * Macro Details:: Beyond basic macro usage. * alias:: Command aliases. * definfoenclose:: Customized highlighting. Formatting and Printing Hardcopy * Use TeX:: Use TeX to format for hardcopy. * Format with tex/texindex:: How to format with explicit shell commands. * Format with texi2dvi:: A simpler way to format. * Print with lpr:: How to print. * Within Emacs:: How to format and print from an Emacs shell. * Texinfo Mode Printing:: How to format and print in Texinfo mode. * Compile-Command:: How to print using Emacs's compile command. * Requirements Summary:: TeX formatting requirements summary. * Preparing for TeX:: What to do before you use TeX. * Overfull hboxes:: What are and what to do with overfull hboxes. * smallbook:: How to print small format books and manuals. * A4 Paper:: How to print on A4 or A5 paper. * pagesizes:: How to print with customized page sizes. * Cropmarks and Magnification:: How to print marks to indicate the size of pages and how to print scaled up output. * PDF Output:: Portable Document Format output. Creating and Installing Info Files * Creating an Info File:: * Installing an Info File:: Creating an Info File * makeinfo advantages:: `makeinfo' provides better error checking. * Invoking makeinfo:: How to run `makeinfo' from a shell. * makeinfo options:: Specify fill-column and other options. * Pointer Validation:: How to check that pointers point somewhere. * makeinfo in Emacs:: How to run `makeinfo' from Emacs. * texinfo-format commands:: Two Info formatting commands written in Emacs Lisp are an alternative to `makeinfo'. * Batch Formatting:: How to format for Info in Emacs Batch mode. * Tag and Split Files:: How tagged and split files help Info to run better. * makeinfo html:: Generating HTML output. Installing an Info File * Directory File:: The top level menu for all Info files. * New Info File:: Listing a new Info file. * Other Info Directories:: How to specify Info files that are located in other directories. * Installing Dir Entries:: How to specify what menu entry to add to the Info directory. * Invoking install-info:: `install-info' options. Include Files * Using Include Files:: How to use the `@include' command. * texinfo-multiple-files-update:: How to create and update nodes and menus when using included files. * Include File Requirements:: What `texinfo-multiple-files-update' expects. * Sample Include File:: A sample outer file with included files within it; and a sample included file. * Include Files Evolution:: How use of the `@include' command has changed over time. Page Headings * Headings Introduced:: Conventions for using page headings. * Heading Format:: Standard page heading formats. * Heading Choice:: How to specify the type of page heading. * Custom Headings:: How to create your own headings and footings. Formatting Mistakes * makeinfo Preferred:: `makeinfo' finds errors. * Debugging with Info:: How to catch errors with Info formatting. * Debugging with TeX:: How to catch errors with TeX formatting. * Using texinfo-show-structure:: How to use `texinfo-show-structure'. * Using occur:: How to list all lines containing a pattern. * Running Info-Validate:: How to find badly referenced nodes. Finding Badly Referenced Nodes * Using Info-validate:: How to run `Info-validate'. * Unsplit:: How to create an unsplit file. * Tagifying:: How to tagify a file. * Splitting:: How to split a file manually. Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing. --Dick Brandon  File: texinfo, Node: Copying, Next: Overview, Prev: Top, Up: Top Texinfo Copying Conditions ************************** The programs currently being distributed that relate to Texinfo include `makeinfo', `info', `texindex', and `texinfo.tex'. These programs are "free"; this means that everyone is free to use them and free to redistribute them on a free basis. The Texinfo-related programs are not in the public domain; they are copyrighted and there are restrictions on their distribution, but these restrictions are designed to permit everything that a good cooperating citizen would want to do. What is not allowed is to try to prevent others from further sharing any version of these programs that they might get from you. Specifically, we want to make sure that you have the right to give away copies of the programs that relate to Texinfo, that you receive source code or else can get it if you want it, that you can change these programs or use pieces of them in new free programs, and that you know you can do these things. To make sure that everyone has such rights, we have to forbid you to deprive anyone else of these rights. For example, if you distribute copies of the Texinfo related programs, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. Also, for our own protection, we must make certain that everyone finds out that there is no warranty for the programs that relate to Texinfo. If these programs are modified by someone else and passed on, we want their recipients to know that what they have is not what we distributed, so that any problems introduced by others will not reflect on our reputation. The precise conditions of the licenses for the programs currently being distributed that relate to Texinfo are found in the General Public Licenses that accompany them.  File: texinfo, Node: Overview, Next: Texinfo Mode, Prev: Copying, Up: Top Overview of Texinfo ******************* "Texinfo"(1) (*note Overview-Footnote-1::) is a documentation system that uses a single source file to produce both online information and printed output. This means that instead of writing two different documents, one for the online information and the other for a printed work, you need write only one document. Therefore, when the work is revised, you need revise only that one document. * Menu: * Reporting Bugs:: Submitting effective bug reports. * Using Texinfo:: Create printed or online output. * Info Files:: What is an Info file? * Printed Books:: Characteristics of a printed book or manual. * Formatting Commands:: @-commands are used for formatting. * Conventions:: General rules for writing a Texinfo file. * Comments:: Writing comments and ignored text in general. * Minimum:: What a Texinfo file must have. * Six Parts:: Usually, a Texinfo file has six parts. * Short Sample:: A short sample Texinfo file. * History:: Acknowledgements, contributors and genesis.  File: texinfo, Node: Overview-Footnotes, Up: Overview (1) The first syllable of "Texinfo" is pronounced like "speck", not "hex". This odd pronunciation is derived from, but is not the same as, the pronunciation of TeX. In the word TeX, the `X' is actually the Greek letter "chi" rather than the English letter "ex". Pronounce TeX as if the `X' were the last sound in the name `Bach'; but pronounce Texinfo as if the `x' were a `k'. Spell "Texinfo" with a capital "T" and the other letters in lower case.  File: texinfo, Node: Reporting Bugs, Next: Using Texinfo, Up: Overview Reporting Bugs ============== We welcome bug reports and suggestions for any aspect of the Texinfo system, programs, documentation, installation, anything. Please email them to . You can get the latest version of Texinfo from `ftp://ftp.gnu.org/gnu/texinfo/' and its mirrors worldwide. For bug reports, please include enough information for the maintainers to reproduce the problem. Generally speaking, that means: * the version number of Texinfo and the program(s) or manual(s) involved. * hardware, operating system, and compiler versions. * any unusual options you gave to `configure'. * the contents of any input files necessary to reproduce the bug. * a description of the problem and samples of any erroneous output. * anything else that you think would be helpful. When in doubt whether something is needed or not, include it. It's better to include too much than to leave out something important. Patches are most welcome; if possible, please make them with `diff -c' (*note Overview: (diffutils)Top.) and include `ChangeLog' entries (*note Change Log: (emacs)Change Log.). When sending patches, if possible please do not encode or split them in any way; it's much easier to deal with one plain text message, however large, than many small ones. GNU shar (ftp://ftp.gnu.org/gnu/sharutils/) is a convenient way of packaging multiple and/or binary files for email.  File: texinfo, Node: Using Texinfo, Next: Info Files, Prev: Reporting Bugs, Up: Overview Using Texinfo ============= Using Texinfo, you can create a printed document with the normal features of a book, including chapters, sections, cross references, and indices. From the same Texinfo source file, you can create a menu-driven, online Info file with nodes, menus, cross references, and indices. You can also create from that same source file an HTML output file suitable for use with a web browser, or an XML file. `The GNU Emacs Manual' is a good example of a Texinfo file, as is this manual. To make a printed document, you process a Texinfo source file with the TeX typesetting program (but the Texinfo language is very different from TeX's usual language, plain TeX). This creates a DVI file that you can typeset and print as a book or report (*note Hardcopy::). To output an Info file, process your Texinfo source with the `makeinfo' utility or Emacs's `texinfo-format-buffer' command. You can install the result in your Info tree (*note Installing an Info File::). To output an HTML file, run `makeinfo --html' on your Texinfo source. You can (for example) install the result on your web site. To output an XML file, run `makeinfo --xml' on your Texinfo source. To output DocBook, run `makeinfo --docbook'. If you want to convert from Docbook _to_ Texinfo, please see `http://docbook2X.sourceforge.net/'. If you are a programmer and would like to contribute to the GNU project by implementing additional output formats for Texinfo, that would be excellent. But please do not write a separate translator texi2foo for your favorite format foo! That is the hard way to do the job, and makes extra work in subsequent maintenance, since the Texinfo language is continually being enhanced and updated. Instead, the best approach is modify `makeinfo' to generate the new format, as it does now for Info and HTML. TeX works with virtually all printers; Info works with virtually all computer terminals; the HTML output works with virtually all web browsers. Thus Texinfo can be used by almost any computer user. A Texinfo source file is a plain ASCII file containing text and "@-commands" (words preceded by an `@') that tell the typesetting and formatting programs what to do. You may edit a Texinfo file with any text editor; but it is especially convenient to use GNU Emacs since that editor has a special mode, called Texinfo mode, that provides various Texinfo-related features. (*Note Texinfo Mode::.) Before writing a Texinfo source file, you should learn about nodes, menus, cross references, and the rest, for example by reading this manual. You can use Texinfo to create both online help and printed manuals; moreover, Texinfo is freely redistributable. For these reasons, Texinfo is the official documentation format of the GNU project. More information is available at the GNU documentation web page (http://www.gnu.org/doc/). From time to time, proposals are made to generate traditional Unix man pages from Texinfo source. This is not likely to ever be supported, because man pages have a very strict conventional format. Merely enhancing `makeinfo' to output troff format would be insufficient. Generating a good man page therefore requires a completely different source than the typical Texinfo applications of generating a good user manual or a good reference manual. This makes generating man pages incompatible with the Texinfo design goal of not having to document the same information in different ways for different output formats. You might as well just write the man page directly. If you wish to support man pages, the program `help2man' may be useful; it generates a traditional man page from the `--help' output of a program. In fact, this is currently used to generate man pages for the Texinfo programs themselves. It is GNU software written by Brendan O'Dea, available from `http://www.ozemail.com.au/~bod/help2man.tar.gz'.  File: texinfo, Node: Info Files, Next: Printed Books, Prev: Using Texinfo, Up: Overview Info files ========== An Info file is a Texinfo file formatted so that the Info documentation reading program can operate on it. (`makeinfo' and `texinfo-format-buffer' are two commands that convert a Texinfo file into an Info file.) Info files are divided into pieces called "nodes", each of which contains the discussion of one topic. Each node has a name, and contains both text for the user to read and pointers to other nodes, which are identified by their names. The Info program displays one node at a time, and provides commands with which the user can move to other related nodes. *note info: (info)Top, for more information about using Info. Each node of an Info file may have any number of child nodes that describe subtopics of the node's topic. The names of child nodes are listed in a "menu" within the parent node; this allows you to use certain Info commands to move to one of the child nodes. Generally, an Info file is organized like a book. If a node is at the logical level of a chapter, its child nodes are at the level of sections; likewise, the child nodes of sections are at the level of subsections. All the children of any one parent are linked together in a bidirectional chain of `Next' and `Previous' pointers. The `Next' pointer provides a link to the next section, and the `Previous' pointer provides a link to the previous section. This means that all the nodes that are at the level of sections within a chapter are linked together. Normally the order in this chain is the same as the order of the children in the parent's menu. Each child node records the parent node name as its `Up' pointer. The last child has no `Next' pointer, and the first child has the parent both as its `Previous' and as its `Up' pointer.(1) (*note Info Files-Footnote-1::) The book-like structuring of an Info file into nodes that correspond to chapters, sections, and the like is a matter of convention, not a requirement. The `Up', `Previous', and `Next' pointers of a node can point to any other nodes, and a menu can contain any other nodes. Thus, the node structure can be any directed graph. But it is usually more comprehensible to follow a structure that corresponds to the structure of chapters and sections in a printed book or report. In addition to menus and to `Next', `Previous', and `Up' pointers, Info provides pointers of another kind, called references, that can be sprinkled throughout the text. This is usually the best way to represent links that do not fit a hierarchical structure. Usually, you will design a document so that its nodes match the structure of chapters and sections in the printed output. But occasionally there are times when this is not right for the material being discussed. Therefore, Texinfo uses separate commands to specify the node structure for the Info file and the section structure for the printed output. Generally, you enter an Info file through a node that by convention is named `Top'. This node normally contains just a brief summary of the file's purpose, and a large menu through which the rest of the file is reached. From this node, you can either traverse the file systematically by going from node to node, or you can go to a specific node listed in the main menu, or you can search the index menus and then go directly to the node that has the information you want. Alternatively, with the standalone Info program, you can specify specific menu items on the command line (*note Top: (info)Top.). If you want to read through an Info file in sequence, as if it were a printed manual, you can hit repeatedly, or you get the whole file with the advanced Info command `g *'. (*note Advanced Info commands: (info)Expert.) The `dir' file in the `info' directory serves as the departure point for the whole Info system. From it, you can reach the `Top' nodes of each of the documents in a complete Info system. If you wish to refer to an Info file in a URI, you can use the (unofficial) syntax exemplified in the following. This works with Emacs/W3, for example: info:///usr/info/emacs#Dissociated%20Press info:emacs#Dissociated%20Press info://localhost/usr/info/emacs#Dissociated%20Press The `info' program itself does not follow URI's of any kind.  File: texinfo, Node: Info Files-Footnotes, Up: Info Files (1) In some documents, the first child has no `Previous' pointer. Occasionally, the last child has the node name of the next following higher level node as its `Next' pointer.  File: texinfo, Node: Printed Books, Next: Formatting Commands, Prev: Info Files, Up: Overview Printed Books ============= A Texinfo file can be formatted and typeset as a printed book or manual. To do this, you need TeX, a powerful, sophisticated typesetting program written by Donald Knuth.(1) (*note Printed Books-Footnote-1::) A Texinfo-based book is similar to any other typeset, printed work: it can have a title page, copyright page, table of contents, and preface, as well as chapters, numbered or unnumbered sections and subsections, page headers, cross references, footnotes, and indices. You can use Texinfo to write a book without ever having the intention of converting it into online information. You can use Texinfo for writing a printed novel, and even to write a printed memo, although this latter application is not recommended since electronic mail is so much easier. TeX is a general purpose typesetting program. Texinfo provides a file `texinfo.tex' that contains information (definitions or "macros") that TeX uses when it typesets a Texinfo file. (`texinfo.tex' tells TeX how to convert the Texinfo @-commands to TeX commands, which TeX can then process to create the typeset document.) `texinfo.tex' contains the specifications for printing a document. You can get the latest version of `texinfo.tex' from `ftp://ftp.gnu.org/gnu/texinfo.tex'. Most often, documents are printed on 8.5 inch by 11 inch pages (216mm by 280mm; this is the default size), but you can also print for 7 inch by 9.25 inch pages (178mm by 235mm; the `@smallbook' size) or on A4 or A5 size paper (`@afourpaper', `@afivepaper'). (*Note Printing "Small" Books: smallbook. Also, see *Note Printing on A4 Paper: A4 Paper.) By changing the parameters in `texinfo.tex', you can change the size of the printed document. In addition, you can change the style in which the printed document is formatted; for example, you can change the sizes and fonts used, the amount of indentation for each paragraph, the degree to which words are hyphenated, and the like. By changing the specifications, you can make a book look dignified, old and serious, or light-hearted, young and cheery. TeX is freely distributable. It is written in a superset of Pascal called WEB and can be compiled either in Pascal or (by using a conversion program that comes with the TeX distribution) in C. (*Note TeX Mode: (emacs)TeX Mode, for information about TeX.) TeX is very powerful and has a great many features. Because a Texinfo file must be able to present information both on a character-only terminal in Info form and in a typeset book, the formatting commands that Texinfo supports are necessarily limited. To get a copy of TeX, see *Note How to Obtain TeX: Obtaining TeX.  File: texinfo, Node: Printed Books-Footnotes, Up: Printed Books (1) You can also use the `texi2roff' (ftp://tug.org/texi2roff.tar.gz) program if you do not have TeX; since Texinfo is designed for use with TeX, `texi2roff' is not described here. `texi2roff' is not part of the standard GNU distribution and is not maintained or up-to-date with all the Texinfo features described in this manual.  File: texinfo, Node: Formatting Commands, Next: Conventions, Prev: Printed Books, Up: Overview @-commands ========== In a Texinfo file, the commands that tell TeX how to typeset the printed manual and tell `makeinfo' and `texinfo-format-buffer' how to create an Info file are preceded by `@'; they are called "@-commands". For example, `@node' is the command to indicate a node and `@chapter' is the command to indicate the start of a chapter. *Please note:* All the @-commands, with the exception of the `@TeX{}' command, must be written entirely in lower case. The Texinfo @-commands are a strictly limited set of constructs. The strict limits make it possible for Texinfo files to be understood both by TeX and by the code that converts them into Info files. You can display Info files on any terminal that displays alphabetic and numeric characters. Similarly, you can print the output generated by TeX on a wide variety of printers. Depending on what they do or what arguments(1) (*note Formatting Commands-Footnote-1::) they take, you need to write @-commands on lines of their own or as part of sentences: * Write a command such as `@noindent' at the beginning of a line as the only text on the line. (`@noindent' prevents the beginning of the next line from being indented as the beginning of a paragraph.) * Write a command such as `@chapter' at the beginning of a line followed by the command's arguments, in this case the chapter title, on the rest of the line. (`@chapter' creates chapter titles.) * Write a command such as `@dots{}' wherever you wish but usually within a sentence. (`@dots{}' creates dots ...) * Write a command such as `@code{SAMPLE-CODE}' wherever you wish (but usually within a sentence) with its argument, SAMPLE-CODE in this example, between the braces. (`@code' marks text as being code.) * Write a command such as `@example' on a line of its own; write the body-text on following lines; and write the matching `@end' command, `@end example' in this case, at the on a line of its own after the body-text. (`@example' ... `@end example' indents and typesets body-text as an example.) It's usually ok to indent environment commands like this, but in complicated and hard-to-define circumstances the extra spaces cause extra space to appear in the output, so beware. As a general rule, a command requires braces if it mingles among other text; but it does not need braces if it starts a line of its own. The non-alphabetic commands, such as `@:', are exceptions to the rule; they do not need braces. As you gain experience with Texinfo, you will rapidly learn how to write the different commands: the different ways to write commands make it easier to write and read Texinfo files than if all commands followed exactly the same syntax. (For details about @-command syntax, see *Note @-Command Syntax: Command Syntax.)  File: texinfo, Node: Formatting Commands-Footnotes, Up: Formatting Commands (1) The word "argument" comes from the way it is used in mathematics and does not refer to a dispute between two people; it refers to the information presented to the command. According to the `Oxford English Dictionary', the word derives from the Latin for "to make clear, prove"; thus it came to mean `the evidence offered as proof', which is to say, `the information offered', which led to its mathematical meaning. In its other thread of derivation, the word came to mean `to assert in a manner against which others may make counter assertions', which led to the meaning of `argument' as a dispute.  File: texinfo, Node: Conventions, Next: Comments, Prev: Formatting Commands, Up: Overview General Syntactic Conventions ============================= This section describes the general conventions used in all Texinfo documents. * All printable ASCII characters except `@', `{' and `}' can appear in a Texinfo file and stand for themselves. `@' is the escape character which introduces commands. `{' and `}' should be used only to surround arguments to certain commands. To put one of these special characters into the document, put an `@' character in front of it, like this: `@@', `@{', and `@}'. * It is customary in TeX to use doubled single-quote characters to begin and end quotations: ` ` and ' ' (but without a space between the two single-quote characters). This convention should be followed in Texinfo files. TeX converts doubled single-quote characters to left- and right-hand doubled quotation marks and Info converts doubled single-quote characters to ASCII double-quotes: ` ` and ' ' to " . * Use three hyphens in a row, `---', for a dash--like this. In TeX, a single or double hyphen produces a printed dash that is shorter than the usual typeset dash. Info reduces three hyphens to two for display on the screen. * To prevent a paragraph from being indented in the printed manual, put the command `@noindent' on a line by itself before the paragraph. * If you mark off a region of the Texinfo file with the `@iftex' and `@end iftex' commands, that region will appear only in the printed copy; in that region, you can use certain commands borrowed from plain TeX that you cannot use in Info. Likewise, if you mark off a region with the `@ifinfo' and `@end ifinfo' commands, that region will appear only in the Info file; in that region, you can use Info commands that you cannot use in TeX. Similarly for `@ifhtml ... @end ifhtml', `@ifnothtml ... @end ifnothtml', `@ifnotinfo ... @end ifnotinfo', `@ifnottex ... @end ifnottex'. *Note Conditionals::. *Caution:* Do not use tabs in a Texinfo file (except in verbatim modes) ! TeX uses variable-width fonts, which means that it is impractical at best to define a tab to work in all circumstances. Consequently, TeX treats tabs like single spaces, and that is not what they look like. Furthermore, `makeinfo' does nothing special with tabs, and thus a tab character in your input file may appear differently in the output, for example, in an indented example. To avoid this problem, Texinfo mode causes GNU Emacs to insert multiple spaces when you press the key. Also, you can run `untabify' in Emacs to convert tabs in a region to multiple spaces.  File: texinfo, Node: Comments, Next: Minimum, Prev: Conventions, Up: Overview Comments ======== You can write comments in a Texinfo file that will not appear in either the Info file or the printed manual by using the `@comment' command (which may be abbreviated to `@c'). Such comments are for the person who revises the Texinfo file. All the text on a line that follows either `@comment' or `@c' is a comment; the rest of the line does not appear in either the Info file or the printed manual. (Often, you can write the `@comment' or `@c' in the middle of a line, and only the text that follows after the `@comment' or `@c' command does not appear; but some commands, such as `@settitle' and `@setfilename', work on a whole line. You cannot use `@comment' or `@c' in a line beginning with such a command.) You can write long stretches of text that will not appear in either the Info file or the printed manual by using the `@ignore' and `@end ignore' commands. Write each of these commands on a line of its own, starting each command at the beginning of the line. Text between these two commands does not appear in the processed output. You can use `@ignore' and `@end ignore' for writing comments. , see *Note How to Obtain TeX: Obtaining TeX.  File: texinfo, Node: Printed Books-Footnotes, Up: Printed Books (1) You can also use the `texi2roff' (ftp://tug.org/texi2rof./info/texinfo-2 644 0 0 140636 7442531461 6713 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Minimum, Next: Six Parts, Prev: Comments, Up: Overview What a Texinfo File Must Have ============================= By convention, the names of Texinfo files end with one of the extensions `.texinfo', `.texi', `.txi', or `.tex'. The longer extension is preferred since it describes more clearly to a human reader the nature of the file. The shorter extensions are for operating systems that cannot handle long file names. In order to be made into a printed manual and an Info file, a Texinfo file *must* begin with lines like this: \input texinfo @setfilename INFO-FILE-NAME @settitle NAME-OF-MANUAL The contents of the file follow this beginning, and then you *must* end a Texinfo file with a line like this: @bye The `\input texinfo' line tells TeX to use the `texinfo.tex' file, which tells TeX how to translate the Texinfo @-commands into TeX typesetting commands. (Note the use of the backslash, `\'; this is correct for TeX.) The `@setfilename' line provides a name for the Info file and tells TeX to open auxiliary files. The `@settitle' line specifies a title for the page headers (or footers) of the printed manual, and the default document description title for the `' in HTML format. The `@bye' line at the end of the file on a line of its own tells the formatters that the file is ended and to stop formatting. Usually, you will not use quite such a spare format, but will include mode setting and start-of-header and end-of-header lines at the beginning of a Texinfo file, like this: \input texinfo @c -*-texinfo-*- @c %**start of header @setfilename INFO-FILE-NAME @settitle NAME-OF-MANUAL @c %**end of header In the first line, `-*-texinfo-*-' causes Emacs to switch into Texinfo mode when you edit the file. The `@c' lines which surround the `@setfilename' and `@settitle' lines are optional, but you need them in order to run TeX or Info on just part of the file. (*Note Start of Header::, for more information.) Furthermore, you will usually provide a Texinfo file with a title page, indices, and the like. But the minimum, which can be useful for short documents, is just the three lines at the beginning and the one line at the end.  File: texinfo, Node: Six Parts, Next: Short Sample, Prev: Minimum, Up: Overview Six Parts of a Texinfo File =========================== Generally, a Texinfo file contains more than the minimal beginning and end--it usually contains six parts: 1. Header The "Header" names the file, tells TeX which definitions' file to use, and performs other "housekeeping" tasks. 2. Summary Description and Copyright The "Summary Description and Copyright" segment describes the document and contains the copyright notice and copying permissions for the Info file. The segment must be enclosed between `@ifinfo' and `@end ifinfo' commands so that the formatters place it only in the Info file. 3. Title and Copyright The "Title and Copyright" segment contains the title and copyright pages and copying permissions for the printed manual. The segment must be enclosed between `@titlepage' and `@end titlepage' commands. The title and copyright page appear only in the printed manual. 4. `Top' Node and Master Menu The "Master Menu" contains a complete menu of all the nodes in the whole Info file. It appears only in the Info file, in the `Top' node. 5. Body The "Body" of the document may be structured like a traditional book or encyclopedia or it may be free form. 6. End The "End" contains commands for printing indices and generating the table of contents, and the `@bye' command on a line of its own.  File: texinfo, Node: Short Sample, Next: History, Prev: Six Parts, Up: Overview A Short Sample Texinfo File =========================== Here is a complete but very short Texinfo file, in six parts. The first three parts of the file, from `\input texinfo' through to `@end titlepage', look more intimidating than they are. Most of the material is standard boilerplate; when you write a manual, simply insert the names for your own manual in this segment. (*Note Beginning a File::.) In the following, the sample text is _indented_; comments on it are not. The complete file, without any comments, is shown in *Note Sample Texinfo File::. Part 1: Header -------------- The header does not appear in either the Info file or the printed output. It sets various parameters, including the name of the Info file and the title used in the header. \input texinfo @c -*-texinfo-*- @c %**start of header @setfilename sample.info @settitle Sample Document @setchapternewpage odd @c %**end of header Part 2: Summary Description and Copyright ----------------------------------------- The summary description and copyright segment does not appear in the printed document. @ifinfo This is a short example of a complete Texinfo file. Copyright @copyright{} 2002 Free Software Foundation, Inc. @end ifinfo Part 3: Titlepage and Copyright ------------------------------- The titlepage segment does not appear in the Info file. @contents @titlepage @sp 10 @title Sample Title @c The following two commands start the copyright page. @page @vskip 0pt plus 1filll Copyright @copyright{} 2002 Free Software Foundation, Inc. @end titlepage Part 4: `Top' Node and Master Menu ---------------------------------- The `Top' node contains the master menu for the Info file. Since a printed manual uses a table of contents rather than a menu, the master menu appears only in online output. @ifnottex @node Top @end ifnottex @menu * First Chapter:: The first chapter is the only chapter in this sample. * Concept Index:: This index has two entries. @end menu Part 5: The Body of the Document --------------------------------- The body segment contains all the text of the document, but not the indices or table of contents. This example illustrates a node and a chapter containing an enumerated list. @node First Chapter @chapter First Chapter @cindex Chapter, first This is the contents of the first chapter. @cindex Another sample index entry Here is a numbered list. @enumerate @item This is the first item. @item This is the second item. @end enumerate The @code{makeinfo} command transforms a Texinfo file such as this into an Info file or other output; @TeX typesets it for a printed manual. Part 6: The End of the Document ------------------------------- The end segment contains commands for generating an index in a node and unnumbered chapter of its own, (usually) for generating the table of contents, and the `@bye' command that marks the end of the document. @node Concept Index @unnumbered Concept Index @printindex cp @bye The Results ----------- Here is what the contents of the first chapter of the sample look like: This is the contents of the first chapter. Here is a numbered list. 1. This is the first item. 2. This is the second item. The `makeinfo' and `texinfo-format-buffer' commands transform a Texinfo file such as this into an Info file; and TeX typesets it for a printed manual.  File: texinfo, Node: History, Prev: Short Sample, Up: Overview History ======= Richard M. Stallman invented the Texinfo format, wrote the initial processors, and created Edition 1.0 of this manual. Robert J. Chassell greatly revised and extended the manual, starting with Edition 1.1. Brian Fox was responsible for the standalone Texinfo distribution until version 3.8, and wrote the standalone `makeinfo' and `info'. Karl Berry has made the updates since Texinfo 3.8 and subsequent releases, starting with Edition 2.22 of the manual. Our thanks go out to all who helped improve this work, particularly to Franc,ois Pinard and David D. Zuhn, who tirelessly recorded and reported mistakes and obscurities; our special thanks go to Melissa Weisshaus for her frequent and often tedious reviews of nearly similar editions. The indefatigable Eli Zaretskii and Andreas Schwab have provided patches beyond counting. Zack Weinberg did the impossible by implementing the macro syntax in `texinfo.tex'. Dozens of others have contributed patches and suggestions, they are gratefully acknowledged in the `ChangeLog' file. Our mistakes are our own. A bit of history: in the 1970's at CMU, Brian Reid developed a program and format named Scribe to mark up documents for printing. It used the `@' character to introduce commands as Texinfo does and strived to describe document contents rather than formatting. Meanwhile, people at MIT developed another, not too dissimilar format called Bolio. This then was converted to using TeX as its typesetting language: BoTeX. BoTeX could only be used as a markup language for documents to be printed, not for online documents. Richard Stallman (RMS) worked on both Bolio and BoTeX. He also developed a nifty on-line help format called Info, and then combined BoTeX and Info to create Texinfo, a mark up language for text that is intended to be read both on line and as printed hard copy.  File: texinfo, Node: Texinfo Mode, Next: Beginning a File, Prev: Overview, Up: Top Using Texinfo Mode ****************** You may edit a Texinfo file with any text editor you choose. A Texinfo file is no different from any other ASCII file. However, GNU Emacs comes with a special mode, called Texinfo mode, that provides Emacs commands and tools to help ease your work. This chapter describes features of GNU Emacs' Texinfo mode but not any features of the Texinfo formatting language. If you are reading this manual straight through from the beginning, you may want to skim through this chapter briefly and come back to it after reading succeeding chapters which describe the Texinfo formatting language in detail. * Menu: * Texinfo Mode Overview:: How Texinfo mode can help you. * Emacs Editing:: Texinfo mode adds to GNU Emacs' general purpose editing features. * Inserting:: How to insert frequently used @-commands. * Showing the Structure:: How to show the structure of a file. * Updating Nodes and Menus:: How to update or create new nodes and menus. * Info Formatting:: How to format for Info. * Printing:: How to format and print part or all of a file. * Texinfo Mode Summary:: Summary of all the Texinfo mode commands.  File: texinfo, Node: Texinfo Mode Overview, Next: Emacs Editing, Prev: Texinfo Mode, Up: Texinfo Mode Texinfo Mode Overview ===================== Texinfo mode provides special features for working with Texinfo files. You can: * Insert frequently used @-commands. * Automatically create `@node' lines. * Show the structure of a Texinfo source file. * Automatically create or update the `Next', `Previous', and `Up' pointers of a node. * Automatically create or update menus. * Automatically create a master menu. * Format a part or all of a file for Info. * Typeset and print part or all of a file. Perhaps the two most helpful features are those for inserting frequently used @-commands and for creating node pointers and menus.  File: texinfo, Node: Emacs Editing, Next: Inserting, Prev: Texinfo Mode Overview, Up: Texinfo Mode The Usual GNU Emacs Editing Commands ==================================== In most cases, the usual Text mode commands work the same in Texinfo mode as they do in Text mode. Texinfo mode adds new editing commands and tools to GNU Emacs' general purpose editing features. The major difference concerns filling. In Texinfo mode, the paragraph separation variable and syntax table are redefined so that Texinfo commands that should be on lines of their own are not inadvertently included in paragraphs. Thus, the `M-q' (`fill-paragraph') command will refill a paragraph but not mix an indexing command on a line adjacent to it into the paragraph. In addition, Texinfo mode sets the `page-delimiter' variable to the value of `texinfo-chapter-level-regexp'; by default, this is a regular expression matching the commands for chapters and their equivalents, such as appendices. With this value for the page delimiter, you can jump from chapter title to chapter title with the `C-x ]' (`forward-page') and `C-x [' (`backward-page') commands and narrow to a chapter with the `C-x p' (`narrow-to-page') command. (*Note Pages: (emacs)Pages, for details about the page commands.) You may name a Texinfo file however you wish, but the convention is to end a Texinfo file name with one of the extensions `.texinfo', `.texi', `.txi', or `.tex'. A longer extension is preferred, since it is explicit, but a shorter extension may be necessary for operating systems that limit the length of file names. GNU Emacs automatically enters Texinfo mode when you visit a file with a `.texinfo', `.texi' or `.txi' extension. Also, Emacs switches to Texinfo mode when you visit a file that has `-*-texinfo-*-' in its first line. If ever you are in another mode and wish to switch to Texinfo mode, type `M-x texinfo-mode'. Like all other Emacs features, you can customize or enhance Texinfo mode as you wish. In particular, the keybindings are very easy to change. The keybindings described here are the default or standard ones.  File: texinfo, Node: Inserting, Next: Showing the Structure, Prev: Emacs Editing, Up: Texinfo Mode Inserting Frequently Used Commands ================================== Texinfo mode provides commands to insert various frequently used @-commands into the buffer. You can use these commands to save keystrokes. The insert commands are invoked by typing `C-c' twice and then the first letter of the @-command: `C-c C-c c' `M-x texinfo-insert-@code' Insert `@code{}' and put the cursor between the braces. `C-c C-c d' `M-x texinfo-insert-@dfn' Insert `@dfn{}' and put the cursor between the braces. `C-c C-c e' `M-x texinfo-insert-@end' Insert `@end' and attempt to insert the correct following word, such as `example' or `table'. (This command does not handle nested lists correctly, but inserts the word appropriate to the immediately preceding list.) `C-c C-c i' `M-x texinfo-insert-@item' Insert `@item' and put the cursor at the beginning of the next line. `C-c C-c k' `M-x texinfo-insert-@kbd' Insert `@kbd{}' and put the cursor between the braces. `C-c C-c n' `M-x texinfo-insert-@node' Insert `@node' and a comment line listing the sequence for the `Next', `Previous', and `Up' nodes. Leave point after the `@node'. `C-c C-c o' `M-x texinfo-insert-@noindent' Insert `@noindent' and put the cursor at the beginning of the next line. `C-c C-c s' `M-x texinfo-insert-@samp' Insert `@samp{}' and put the cursor between the braces. `C-c C-c t' `M-x texinfo-insert-@table' Insert `@table' followed by a and leave the cursor after the . `C-c C-c v' `M-x texinfo-insert-@var' Insert `@var{}' and put the cursor between the braces. `C-c C-c x' `M-x texinfo-insert-@example' Insert `@example' and put the cursor at the beginning of the next line. `C-c C-c {' `M-x texinfo-insert-braces' Insert `{}' and put the cursor between the braces. `C-c C-c }' `C-c C-c ]' `M-x up-list' Move from between a pair of braces forward past the closing brace. Typing `C-c C-c ]' is easier than typing `C-c C-c }', which is, however, more mnemonic; hence the two keybindings. (Also, you can move out from between braces by typing `C-f'.) To put a command such as `@code{...}' around an _existing_ word, position the cursor in front of the word and type `C-u 1 C-c C-c c'. This makes it easy to edit existing plain text. The value of the prefix argument tells Emacs how many words following point to include between braces--`1' for one word, `2' for two words, and so on. Use a negative argument to enclose the previous word or words. If you do not specify a prefix argument, Emacs inserts the @-command string and positions the cursor between the braces. This feature works only for those @-commands that operate on a word or words within one line, such as `@kbd' and `@var'. This set of insert commands was created after analyzing the frequency with which different @-commands are used in the `GNU Emacs Manual' and the `GDB Manual'. If you wish to add your own insert commands, you can bind a keyboard macro to a key, use abbreviations, or extend the code in `texinfo.el'. `C-c C-c C-d' (`texinfo-start-menu-description') is an insert command that works differently from the other insert commands. It inserts a node's section or chapter title in the space for the description in a menu entry line. (A menu entry has three parts, the entry name, the node name, and the description. Only the node name is required, but a description helps explain what the node is about. *Note The Parts of a Menu: Menu Parts.) To use `texinfo-start-menu-description', position point in a menu entry line and type `C-c C-c C-d'. The command looks for and copies the title that goes with the node name, and inserts the title as a description; it positions point at beginning of the inserted text so you can edit it. The function does not insert the title if the menu entry line already contains a description. This command is only an aid to writing descriptions; it does not do the whole job. You must edit the inserted text since a title tends to use the same words as a node name but a useful description uses different words.  File: texinfo, Node: Showing the Structure, Next: Updating Nodes and Menus, Prev: Inserting, Up: Texinfo Mode Showing the Section Structure of a File ======================================= You can show the section structure of a Texinfo file by using the `C-c C-s' command (`texinfo-show-structure'). This command shows the section structure of a Texinfo file by listing the lines that begin with the @-commands for `@chapter', `@section', and the like. It constructs what amounts to a table of contents. These lines are displayed in another buffer called the `*Occur*' buffer. In that buffer, you can position the cursor over one of the lines and use the `C-c C-c' command (`occur-mode-goto-occurrence'), to jump to the corresponding spot in the Texinfo file. `C-c C-s' `M-x texinfo-show-structure' Show the `@chapter', `@section', and such lines of a Texinfo file. `C-c C-c' `M-x occur-mode-goto-occurrence' Go to the line in the Texinfo file corresponding to the line under the cursor in the `*Occur*' buffer. If you call `texinfo-show-structure' with a prefix argument by typing `C-u C-c C-s', it will list not only those lines with the @-commands for `@chapter', `@section', and the like, but also the `@node' lines. You can use `texinfo-show-structure' with a prefix argument to check whether the `Next', `Previous', and `Up' pointers of an `@node' line are correct. Often, when you are working on a manual, you will be interested only in the structure of the current chapter. In this case, you can mark off the region of the buffer that you are interested in by using the `C-x n n' (`narrow-to-region') command and `texinfo-show-structure' will work on only that region. To see the whole buffer again, use `C-x n w' (`widen'). (*Note Narrowing: (emacs)Narrowing, for more information about the narrowing commands.) In addition to providing the `texinfo-show-structure' command, Texinfo mode sets the value of the page delimiter variable to match the chapter-level @-commands. This enables you to use the `C-x ]' (`forward-page') and `C-x [' (`backward-page') commands to move forward and backward by chapter, and to use the `C-x p' (`narrow-to-page') command to narrow to a chapter. *Note Pages: (emacs)Pages, for more information about the page commands.  File: texinfo, Node: Updating Nodes and Menus, Next: Info Formatting, Prev: Showing the Structure, Up: Texinfo Mode Updating Nodes and Menus ======================== Texinfo mode provides commands for automatically creating or updating menus and node pointers. The commands are called "update" commands because their most frequent use is for updating a Texinfo file after you have worked on it; but you can use them to insert the `Next', `Previous', and `Up' pointers into an `@node' line that has none and to create menus in a file that has none. If you do not use the updating commands, you need to write menus and node pointers by hand, which is a tedious task. * Menu: * Updating Commands:: Five major updating commands. * Updating Requirements:: How to structure a Texinfo file for using the updating command. * Other Updating Commands:: How to indent descriptions, insert missing nodes lines, and update nodes in sequence.  File: texinfo, Node: Updating Commands, Next: Updating Requirements, Prev: Updating Nodes and Menus, Up: Updating Nodes and Menus The Updating Commands --------------------- You can use the updating commands to: * insert or update the `Next', `Previous', and `Up' pointers of a node, * insert or update the menu for a section, and * create a master menu for a Texinfo source file. You can also use the commands to update all the nodes and menus in a region or in a whole Texinfo file. The updating commands work only with conventional Texinfo files, which are structured hierarchically like books. In such files, a structuring command line must follow closely after each `@node' line, except for the `Top' `@node' line. (A "structuring command line" is a line beginning with `@chapter', `@section', or other similar command.) You can write the structuring command line on the line that follows immediately after an `@node' line or else on the line that follows after a single `@comment' line or a single `@ifinfo' line. You cannot interpose more than one line between the `@node' line and the structuring command line; and you may interpose only an `@comment' line or an `@ifinfo' line. Commands which work on a whole buffer require that the `Top' node be followed by a node with an `@chapter' or equivalent-level command. The menu updating commands will not create a main or master menu for a Texinfo file that has only `@chapter'-level nodes! The menu updating commands only create menus _within_ nodes for lower level nodes. To create a menu of chapters, you must provide a `Top' node. The menu updating commands remove menu entries that refer to other Info files since they do not refer to nodes within the current buffer. This is a deficiency. Rather than use menu entries, you can use cross references to refer to other Info files. None of the updating commands affect cross references. Texinfo mode has five updating commands that are used most often: two are for updating the node pointers or menu of a single node (or a region); two are for updating every node pointer and menu in a file; and one, the `texinfo-master-menu' command, is for creating a master menu for a complete file, and optionally, for updating every node and menu in the whole Texinfo file. The `texinfo-master-menu' command is the primary command: `C-c C-u m' `M-x texinfo-master-menu' Create or update a master menu that includes all the other menus (incorporating the descriptions from pre-existing menus, if any). With an argument (prefix argument, `C-u,' if interactive), first create or update all the nodes and all the regular menus in the buffer before constructing the master menu. (*Note The Top Node and Master Menu: The Top Node, for more about a master menu.) For `texinfo-master-menu' to work, the Texinfo file must have a `Top' node and at least one subsequent node. After extensively editing a Texinfo file, you can type the following: C-u M-x texinfo-master-menu or C-u C-c C-u m This updates all the nodes and menus completely and all at once. The other major updating commands do smaller jobs and are designed for the person who updates nodes and menus as he or she writes a Texinfo file. The commands are: `C-c C-u C-n' `M-x texinfo-update-node' Insert the `Next', `Previous', and `Up' pointers for the node that point is within (i.e., for the `@node' line preceding point). If the `@node' line has pre-existing `Next', `Previous', or `Up' pointers in it, the old pointers are removed and new ones inserted. With an argument (prefix argument, `C-u', if interactive), this command updates all `@node' lines in the region (which is the text between point and mark). `C-c C-u C-m' `M-x texinfo-make-menu' Create or update the menu in the node that point is within. With an argument (`C-u' as prefix argument, if interactive), the command makes or updates menus for the nodes which are either within or a part of the region. Whenever `texinfo-make-menu' updates an existing menu, the descriptions from that menu are incorporated into the new menu. This is done by copying descriptions from the existing menu to the entries in the new menu that have the same node names. If the node names are different, the descriptions are not copied to the new menu. `C-c C-u C-e' `M-x texinfo-every-node-update' Insert or update the `Next', `Previous', and `Up' pointers for every node in the buffer. `C-c C-u C-a' `M-x texinfo-all-menus-update' Create or update all the menus in the buffer. With an argument (`C-u' as prefix argument, if interactive), first insert or update all the node pointers before working on the menus. If a master menu exists, the `texinfo-all-menus-update' command updates it; but the command does not create a new master menu if none already exists. (Use the `texinfo-master-menu' command for that.) When working on a document that does not merit a master menu, you can type the following: C-u C-c C-u C-a or C-u M-x texinfo-all-menus-update This updates all the nodes and menus. The `texinfo-column-for-description' variable specifies the column to which menu descriptions are indented. By default, the value is 32 although it is often useful to reduce it to as low as 24. You can set the variable with the `M-x edit-options' command (*note Editing Variable Values: (emacs)Edit Options.) or with the `M-x set-variable' command (*note Examining and Setting Variables: (emacs)Examining.). Also, the `texinfo-indent-menu-description' command may be used to indent existing menu descriptions to a specified column. Finally, if you wish, you can use the `texinfo-insert-node-lines' command to insert missing `@node' lines into a file. (*Note Other Updating Commands::, for more information.)  File: texinfo, Node: Updating Requirements, Next: Other Updating Commands, Prev: Updating Commands, Up: Updating Nodes and Menus Updating Requirements --------------------- To use the updating commands, you must organize the Texinfo file hierarchically with chapters, sections, subsections, and the like. When you construct the hierarchy of the manual, do not `jump down' more than one level at a time: you can follow the `Top' node with a chapter, but not with a section; you can follow a chapter with a section, but not with a subsection. However, you may `jump up' any number of levels at one time--for example, from a subsection to a chapter. Each `@node' line, with the exception of the line for the `Top' node, must be followed by a line with a structuring command such as `@chapter', `@section', or `@unnumberedsubsec'. Each `@node' line/structuring-command line combination must look either like this: @node Comments, Minimum, Conventions, Overview @comment node-name, next, previous, up @section Comments or like this (without the `@comment' line): @node Comments, Minimum, Conventions, Overview @section Comments In this example, `Comments' is the name of both the node and the section. The next node is called `Minimum' and the previous node is called `Conventions'. The `Comments' section is within the `Overview' node, which is specified by the `Up' pointer. (Instead of an `@comment' line, you may also write an `@ifinfo' line.) If a file has a `Top' node, it must be called `top' or `Top' and be the first node in the file. The menu updating commands create a menu of sections within a chapter, a menu of subsections within a section, and so on. This means that you must have a `Top' node if you want a menu of chapters. Incidentally, the `makeinfo' command will create an Info file for a hierarchically organized Texinfo file that lacks `Next', `Previous' and `Up' pointers. Thus, if you can be sure that your Texinfo file will be formatted with `makeinfo', you have no need for the update node commands. (*Note Creating an Info File::, for more information about `makeinfo'.) However, both `makeinfo' and the `texinfo-format-...' commands require that you insert menus in the file.  File: texinfo, Node: Other Updating Commands, Prev: Updating Requirements, Up: Updating Nodes and Menus Other Updating Commands ----------------------- In addition to the five major updating commands, Texinfo mode possesses several less frequently used updating commands: `M-x texinfo-insert-node-lines' Insert `@node' lines before the `@chapter', `@section', and other sectioning commands wherever they are missing throughout a region in a Texinfo file. With an argument (`C-u' as prefix argument, if interactive), the `texinfo-insert-node-lines' command not only inserts `@node' lines but also inserts the chapter or section titles as the names of the corresponding nodes. In addition, it inserts the titles as node names in pre-existing `@node' lines that lack names. Since node names should be more concise than section or chapter titles, you must manually edit node names so inserted. For example, the following marks a whole buffer as a region and inserts `@node' lines and titles throughout: C-x h C-u M-x texinfo-insert-node-lines This command inserts titles as node names in `@node' lines; the `texinfo-start-menu-description' command (*note Inserting Frequently Used Commands: Inserting.) inserts titles as descriptions in menu entries, a different action. However, in both cases, you need to edit the inserted text. `M-x texinfo-multiple-files-update' Update nodes and menus in a document built from several separate files. With `C-u' as a prefix argument, create and insert a master menu in the outer file. With a numeric prefix argument, such as `C-u 2', first update all the menus and all the `Next', `Previous', and `Up' pointers of all the included files before creating and inserting a master menu in the outer file. The `texinfo-multiple-files-update' command is described in the appendix on `@include' files. *Note texinfo-multiple-files-update::. `M-x texinfo-indent-menu-description' Indent every description in the menu following point to the specified column. You can use this command to give yourself more space for descriptions. With an argument (`C-u' as prefix argument, if interactive), the `texinfo-indent-menu-description' command indents every description in every menu in the region. However, this command does not indent the second and subsequent lines of a multi-line description. `M-x texinfo-sequential-node-update' Insert the names of the nodes immediately following and preceding the current node as the `Next' or `Previous' pointers regardless of those nodes' hierarchical level. This means that the `Next' node of a subsection may well be the next chapter. Sequentially ordered nodes are useful for novels and other documents that you read through sequentially. (However, in Info, the `g *' command lets you look through the file sequentially, so sequentially ordered nodes are not strictly necessary.) With an argument (prefix argument, if interactive), the `texinfo-sequential-node-update' command sequentially updates all the nodes in the region.  File: texinfo, Node: Info Formatting, Next: Printing, Prev: Updating Nodes and Menus, Up: Texinfo Mode Formatting for Info =================== Texinfo mode provides several commands for formatting part or all of a Texinfo file for Info. Often, when you are writing a document, you want to format only part of a file--that is, a region. You can use either the `texinfo-format-region' or the `makeinfo-region' command to format a region: `C-c C-e C-r' `M-x texinfo-format-region' `C-c C-m C-r' `M-x makeinfo-region' Format the current region for Info. You can use either the `texinfo-format-buffer' or the `makeinfo-buffer' command to format a whole buffer: `C-c C-e C-b' `M-x texinfo-format-buffer' `C-c C-m C-b' `M-x makeinfo-buffer' Format the current buffer for Info. For example, after writing a Texinfo file, you can type the following: C-u C-c C-u m or C-u M-x texinfo-master-menu This updates all the nodes and menus. Then type the following to create an Info file: C-c C-m C-b or M-x makeinfo-buffer For TeX or the Info formatting commands to work, the file _must_ include a line that has `@setfilename' in its header. *Note Creating an Info File::, for details about Info formatting.  File: texinfo, Node: Printing, Next: Texinfo Mode Summary, Prev: Info Formatting, Up: Texinfo Mode Formatting and Printing ======================= Typesetting and printing a Texinfo file is a multi-step process in which you first create a file for printing (called a DVI file), and then print the file. Optionally, you may also create indices. To do this, you must run the `texindex' command after first running the `tex' typesetting command; and then you must run the `tex' command again. Or else run the `texi2dvi' command which automatically creates indices as needed (*note Format with texi2dvi::). Often, when you are writing a document, you want to typeset and print only part of a file to see what it will look like. You can use the `texinfo-tex-region' and related commands for this purpose. Use the `texinfo-tex-buffer' command to format all of a buffer. `C-c C-t C-b' `M-x texinfo-tex-buffer' Run `texi2dvi' on the buffer. In addition to running TeX on the buffer, this command automatically creates or updates indices as needed. `C-c C-t C-r' `M-x texinfo-tex-region' Run TeX on the region. `C-c C-t C-i' `M-x texinfo-texindex' Run `texindex' to sort the indices of a Texinfo file formatted with `texinfo-tex-region'. The `texinfo-tex-region' command does not run `texindex' automatically; it only runs the `tex' typesetting command. You must run the `texinfo-tex-region' command a second time after sorting the raw index files with the `texindex' command. (Usually, you do not format an index when you format a region, only when you format a buffer. Now that the `texi2dvi' command exists, there is little or no need for this command.) `C-c C-t C-p' `M-x texinfo-tex-print' Print the file (or the part of the file) previously formatted with `texinfo-tex-buffer' or `texinfo-tex-region'. For `texinfo-tex-region' or `texinfo-tex-buffer' to work, the file _must_ start with a `\input texinfo' line and must include an `@settitle' line. The file must end with `@bye' on a line by itself. (When you use `texinfo-tex-region', you must surround the `@settitle' line with start-of-header and end-of-header lines.) *Note Hardcopy::, for a description of the other TeX related commands, such as `tex-show-print-queue'.  File: texinfo, Node: Texinfo Mode Summary, Prev: Printing, Up: Texinfo Mode Texinfo Mode Summary ==================== In Texinfo mode, each set of commands has default keybindings that begin with the same keys. All the commands that are custom-created for Texinfo mode begin with `C-c'. The keys are somewhat mnemonic. Insert Commands --------------- The insert commands are invoked by typing `C-c' twice and then the first letter of the @-command to be inserted. (It might make more sense mnemonically to use `C-c C-i', for `custom insert', but `C-c C-c' is quick to type.) C-c C-c c Insert `@code'. C-c C-c d Insert `@dfn'. C-c C-c e Insert `@end'. C-c C-c i Insert `@item'. C-c C-c n Insert `@node'. C-c C-c s Insert `@samp'. C-c C-c v Insert `@var'. C-c C-c { Insert braces. C-c C-c ] C-c C-c } Move out of enclosing braces. C-c C-c C-d Insert a node's section title in the space for the description in a menu entry line. Show Structure -------------- The `texinfo-show-structure' command is often used within a narrowed region. C-c C-s List all the headings. The Master Update Command ------------------------- The `texinfo-master-menu' command creates a master menu; and can be used to update every node and menu in a file as well. C-c C-u m M-x texinfo-master-menu Create or update a master menu. C-u C-c C-u m With `C-u' as a prefix argument, first create or update all nodes and regular menus, and then create a master menu. Update Pointers --------------- The update pointer commands are invoked by typing `C-c C-u' and then either `C-n' for `texinfo-update-node' or `C-e' for `texinfo-every-node-update'. C-c C-u C-n Update a node. C-c C-u C-e Update every node in the buffer. Update Menus ------------ Invoke the update menu commands by typing `C-c C-u' and then either `C-m' for `texinfo-make-menu' or `C-a' for `texinfo-all-menus-update'. To update both nodes and menus at the same time, precede `C-c C-u C-a' with `C-u'. C-c C-u C-m Make or update a menu. C-c C-u C-a Make or update all menus in a buffer. C-u C-c C-u C-a With `C-u' as a prefix argument, first create or update all nodes and then create or update all menus. Format for Info --------------- The Info formatting commands that are written in Emacs Lisp are invoked by typing `C-c C-e' and then either `C-r' for a region or `C-b' for the whole buffer. The Info formatting commands that are written in C and based on the `makeinfo' program are invoked by typing `C-c C-m' and then either `C-r' for a region or `C-b' for the whole buffer. Use the `texinfo-format...' commands: C-c C-e C-r Format the region. C-c C-e C-b Format the buffer. Use `makeinfo': C-c C-m C-r Format the region. C-c C-m C-b Format the buffer. C-c C-m C-l Recenter the `makeinfo' output buffer. C-c C-m C-k Kill the `makeinfo' formatting job. Typeset and Print ----------------- The TeX typesetting and printing commands are invoked by typing `C-c C-t' and then another control command: `C-r' for `texinfo-tex-region', `C-b' for `texinfo-tex-buffer', and so on. C-c C-t C-r Run TeX on the region. C-c C-t C-b Run `texi2dvi' on the buffer. C-c C-t C-i Run `texindex'. C-c C-t C-p Print the DVI file. C-c C-t C-q Show the print queue. C-c C-t C-d Delete a job from the print queue. C-c C-t C-k Kill the current TeX formatting job. C-c C-t C-x Quit a currently stopped TeX formatting job. C-c C-t C-l Recenter the output buffer. Other Updating Commands ----------------------- The remaining updating commands do not have standard keybindings because they are rarely used. M-x texinfo-insert-node-lines Insert missing `@node' lines in region. With `C-u' as a prefix argument, use section titles as node names. M-x texinfo-multiple-files-update Update a multi-file document. With `C-u 2' as a prefix argument, create or update all nodes and menus in all included files first. M-x texinfo-indent-menu-description Indent descriptions. M-x texinfo-sequential-node-update Insert node pointers in strict sequence.  File: texinfo, Node: Beginning a File, Next: Ending a File, Prev: Texinfo Mode, Up: Top Beginning a Texinfo File ************************ Certain pieces of information must be provided at the beginning of a Texinfo file, such as the name of the file and the title of the document. * Menu: * Four Parts:: Four parts begin a Texinfo file. * Sample Beginning:: Here is a sample beginning for a Texinfo file. * Header:: The very beginning of a Texinfo file. * Info Summary and Permissions:: Summary and copying permissions for Info. * Titlepage & Copyright Page:: Creating the title and copyright pages. * The Top Node:: Creating the `Top' node and master menu. * Software Copying Permissions:: Ensure that you and others continue to have the right to use and share software.  File: texinfo, Node: Four Parts, Next: Sample Beginning, Prev: Beginning a File, Up: Beginning a File Four Parts Begin a File ======================= Generally, the beginning of a Texinfo file has four parts: 1. The header, delimited by special comment lines, that includes the commands for naming the Texinfo file and telling TeX what definitions file to use when processing the Texinfo file. 2. A short statement of what the file is about, with a copyright notice and copying permissions. This is enclosed in `@ifinfo' and `@end ifinfo' commands so that the formatters place it only in the Info file. 3. A title page and copyright page, with a copyright notice and copying permissions. This is enclosed between `@titlepage' and `@end titlepage' commands. The title and copyright page appear only in the printed manual. 4. The `Top' node that contains a menu for the whole Info file. The contents of this node appear only in the Info file. Also, optionally, you may include the copying conditions for a program and a warranty disclaimer. The copying section will be followed by an introduction or else by the first chapter of the manual. Since the copyright notice and copying permissions for the Texinfo document (in contrast to the copying permissions for a program) are in parts that appear only in the Info file or only in the printed manual, this information must be given twice.  File: texinfo, Node: Sample Beginning, Next: Header, Prev: Four Parts, Up: Beginning a File Sample Texinfo File Beginning ============================= The following sample shows what is needed. \input texinfo @c -*-texinfo-*- @c %**start of header @setfilename NAME-OF-INFO-FILE @settitle NAME-OF-MANUAL @setchapternewpage odd @c %**end of header @ifinfo This file documents ... Copyright YEAR COPYRIGHT-OWNER Permission is granted to ... @end ifinfo @c This title page illustrates only one of the @c two methods of forming a title page. @titlepage @title NAME-OF-MANUAL-WHEN-PRINTED @subtitle SUBTITLE-IF-ANY @subtitle SECOND-SUBTITLE @author AUTHOR @c The following two commands @c start the copyright page. @page @vskip 0pt plus 1filll Copyright @copyright{} YEAR COPYRIGHT-OWNER Published by ... Permission is granted to ... @end titlepage @ifnottex @node Top @top TITLE This document describes ... This document applies to version ... of the program named ... @end ifnottex @menu * Copying:: Your rights and freedoms. * First Chapter:: Getting started ... * Second Chapter:: ... ... ... @end menu @node First Chapter @chapter First Chapter @cindex Index entry for First Chapter  File: texinfo, Node: Header, Next: Info Summary and Permissions, Prev: Sample Beginning, Up: Beginning a File The Texinfo File Header ======================= Texinfo files start with at least three lines that provide Info and TeX with necessary information. These are the `\input texinfo' line, the `@settitle' line, and the `@setfilename' line. If you want to run TeX on just a part of the Texinfo file, you must write the `@settitle' and `@setfilename' lines between start-of-header and end-of-header lines. Thus, the beginning of a Texinfo file looks like this: \input texinfo @c -*-texinfo-*- @setfilename sample.info @settitle Sample Document or else like this: \input texinfo @c -*-texinfo-*- @c %**start of header @setfilename sample.info @settitle Sample Document @c %**end of header * Menu: * First Line:: The first line of a Texinfo file. * Start of Header:: Formatting a region requires this. * setfilename:: Tell Info the name of the Info file. * settitle:: Create a title for the printed work. * documentdescription:: Document summary for the HTML output. * setchapternewpage:: Start chapters on right-hand pages. * paragraphindent:: Specify paragraph indentation. * exampleindent:: Specify environment indentation. * End of Header:: Formatting a region requires this.  File: texinfo, Node: First Line, Next: Start of Header, Up: Header The First Line of a Texinfo File -------------------------------- Every Texinfo file that is to be the top-level input to TeX must begin with a line that looks like this: \input texinfo @c -*-texinfo-*- This line serves two functions: 1. When the file is processed by TeX, the `\input texinfo' command tells TeX to load the macros needed for processing a Texinfo file. These are in a file called `texinfo.tex', which is usually located in the `/usr/lib/tex/macros' directory. TeX uses the backslash, `\', to mark the beginning of a command, just as Texinfo uses `@'. The `texinfo.tex' file causes the switch from `\' to `@'; before the switch occurs, TeX requires `\', which is why it appears at the beginning of the file. 2. When the file is edited in GNU Emacs, the `-*-texinfo-*-' mode specification tells Emacs to use Texinfo mode.  File: texinfo, Node: Start of Header, Next: setfilename, Prev: First Line, Up: Header Start of Header --------------- Write a start-of-header line on the second line of a Texinfo file. Follow the start-of-header line with `@setfilename' and `@settitle' lines and, optionally, with other command lines, such as `@smallbook' or `@footnotestyle'; and then by an end-of-header line (*note End of Header::). With these lines, you can format part of a Texinfo file for Info or typeset part for printing. A start-of-header line looks like this: @c %**start of header The odd string of characters, `%**', is to ensure that no other comment is accidentally taken for a start-of-header line. uffer. C-c C-t C-i Run `texindex'. C-c C-t C-p Print the DVI file. C-c C-t ./info/texinfo-3 644 0 0 143162 7442531461 6711 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: setfilename, Next: settitle, Prev: Start of Header, Up: Header `@setfilename' -------------- In order to serve as the primary input file for either `makeinfo' or TeX, a Texinfo file must contain a line that looks like this: @setfilename INFO-FILE-NAME Write the `@setfilename' command at the beginning of a line and follow it on the same line by the Info file name. Do not write anything else on the line; anything on the line after the command is considered part of the file name, including what would otherwise be a comment. The `@setfilename' line specifies the name of the output file to be generated. This name should be different from the name of the Texinfo file. There are two conventions for choosing the name: you can either remove the extension (such as `.texi') from the input file name, or replace it with the `.info' extension. When producing HTML output, `makeinfo' will replace any extension with `html', or add `.html' if the given name has no extension. Some operating systems cannot handle long file names. You can run into a problem even when the file name you specify is itself short enough. This occurs because the Info formatters split a long Info file into short indirect subfiles, and name them by appending `-1', `-2', ..., `-10', `-11', and so on, to the original file name. (*Note Tag Files and Split Files: Tag and Split Files.) The subfile name `texinfo.info-10', for example, is too long for some systems; so the Info file name for this document is `texinfo' rather than `texinfo.info'. When `makeinfo' is running on operating systems such as MS-DOS which impose grave limits on file names, it will sometimes remove some characters from the original file name to leave enough space for the subfile suffix, thus producing files named `texin-10', `gcc.i12', etc. The Info formatting commands ignore everything written before the `@setfilename' line, which is why the very first line of the file (the `\input' line) does not show up in the output. The `@setfilename' line produces no output when you typeset a manual with TeX, but it is nevertheless essential: it opens the index, cross-reference, and other auxiliary files used by Texinfo, and also reads `texinfo.cnf' if that file is present on your system (*note Preparing for TeX: Preparing for TeX.).  File: texinfo, Node: settitle, Next: documentdescription, Prev: setfilename, Up: Header `@settitle': Set the document title ----------------------------------- In order to be made into a printed manual, a Texinfo file must contain a line that looks like this: @settitle TITLE In the HTML file produced by `makeinfo', TITLE serves as the default document description in the `' part; see *Note documentdescription::, for how to change that. Write the `@settitle' command at the beginning of a line and follow it on the same line by the title. This tells TeX the title to use in a header or footer. Do not write anything else on the line; anything on the line after the command is considered part of the title, including a comment. Conventionally, when TeX formats a Texinfo file for double-sided output, the title is printed in the left-hand (even-numbered) page headings and the current chapter title is printed in the right-hand (odd-numbered) page headings. (TeX learns the title of each chapter from each `@chapter' command.) Page footers are not printed. Even if you are printing in a single-sided style, TeX looks for an `@settitle' command line, in case you include the manual title in the heading. The `@settitle' command should precede everything that generates actual output in TeX. Although the title in the `@settitle' command is usually the same as the title on the title page, it does not affect the title as it appears on the title page. Thus, the two do not need not match exactly; and the title in the `@settitle' command can be a shortened or expanded version of the title as it appears on the title page. (*Note `@titlepage': titlepage.) TeX prints page headings only for that text that comes after the `@end titlepage' command in the Texinfo file, or that comes after an `@headings' command that turns on headings. (*Note The `@headings' Command: headings on off, for more information.) You may, if you wish, create your own, customized headings and footings. *Note Page Headings: Headings, for a detailed discussion of this process.  File: texinfo, Node: documentdescription, Next: setchapternewpage, Prev: settitle, Up: Header `@documentdescription': Summary text ------------------------------------ When producing HTML output for a document, `makeinfo' writes a `' element in the `' to give some idea of the content of the document. By default, this "description" is the title of the document, taken from the `@settitle' command (*note settitle::). To change this, use the `@documentdescription' environment, as in: @documentdescription descriptive text @end documendescription This will produce the following output in the `' of the HTML: `@documentdescription' must be specified before the first node of the document.  File: texinfo, Node: setchapternewpage, Next: paragraphindent, Prev: documentdescription, Up: Header `@setchapternewpage': --------------------- In an officially bound book, text is usually printed on both sides of the paper, chapters start on right-hand pages, and right-hand pages have odd numbers. But in short reports, text often is printed only on one side of the paper. Also in short reports, chapters sometimes do not start on new pages, but are printed on the same page as the end of the preceding chapter, after a small amount of vertical whitespace. You can use the `@setchapternewpage' command with various arguments to specify how TeX should start chapters and whether it should format headers for printing on one or both sides of the paper (single-sided or double-sided printing). Write the `@setchapternewpage' command at the beginning of a line followed by its argument. For example, you would write the following to cause each chapter to start on a fresh odd-numbered page: @setchapternewpage odd You can specify one of three alternatives with the `@setchapternewpage' command: `@setchapternewpage off' Cause TeX to typeset a new chapter on the same page as the last chapter, after skipping some vertical whitespace. Also, cause TeX to format page headers for single-sided printing. `@setchapternewpage on' Cause TeX to start new chapters on new pages and to format page headers for single-sided printing. This is the form most often used for short reports or personal printing. This is the default. `@setchapternewpage odd' Cause TeX to start new chapters on new, odd-numbered pages (right-handed pages) and to typeset for double-sided printing. This is the form most often used for books and manuals. Texinfo does not have an `@setchapternewpage even' command, because there is no printing tradition of starting chapters or books on an even-numbered page. If you don't like the default headers that `@setchapternewpage' sets, you can explicit control them with the `@headings' command. *Note The `@headings' Command: headings on off. At the beginning of a manual or book, pages are not numbered--for example, the title and copyright pages of a book are not numbered. By convention, table of contents and frontmatter pages are numbered with roman numerals and not in sequence with the rest of the document. Since an Info file does not have pages, the `@setchapternewpage' command has no effect on it. We recommend not including any `@setchapternewpage' command in your manual sources at all, since the desired output is not intrinsic to the document. Instead, if you don't want the default option (no blank pages, same headers on all pages) use the `--texinfo' option to `texi2dvi' to specify the output you want.  File: texinfo, Node: paragraphindent, Next: exampleindent, Prev: setchapternewpage, Up: Header Paragraph Indenting ------------------- The Texinfo processors may insert whitespace at the beginning of the first line of each paragraph, thereby indenting that paragraph. You can use the `@paragraphindent' command to specify this indentation. Write an `@paragraphindent' command at the beginning of a line followed by either `asis' or a number: @paragraphindent INDENT The indentation is according to the value of INDENT: `asis' Do not change the existing indentation (not implemented in TeX). 0 Omit all indentation. N Indent by N space characters in Info output, by N ems in TeX. The default value of INDENT is `asis'. `@paragraphindent' is ignored for HTML output. Write the `@paragraphindent' command before or shortly after the end-of-header line at the beginning of a Texinfo file. (If you write the command between the start-of-header and end-of-header lines, the region formatting commands indent paragraphs as specified.) A peculiarity of the `texinfo-format-buffer' and `texinfo-format-region' commands is that they do not indent (nor fill) paragraphs that contain `@w' or `@*' commands. *Note Refilling Paragraphs::, for further information.  File: texinfo, Node: exampleindent, Next: End of Header, Prev: paragraphindent, Up: Header `@exampleindent': Environment Indenting --------------------------------------- The Texinfo processors indent each line of `@example' and similar environments. You can use the `@exampleindent' command to specify this indentation. Write an `@exampleindent' command at the beginning of a line followed by either `asis' or a number: @exampleindent INDENT The indentation is according to the value of INDENT: `asis' Do not change the existing indentation (not implemented in TeX). 0 Omit all indentation. N Indent environments by N space characters in Info output, by N ems in TeX. The default value of INDENT is 5. `@exampleindent' is ignored for HTML output. Write the `@exampleindent' command before or shortly after the end-of-header line at the beginning of a Texinfo file. (If you write the command between the start-of-header and end-of-header lines, the region formatting commands indent examples as specified.)  File: texinfo, Node: End of Header, Prev: exampleindent, Up: Header End of Header ------------- Follow the header lines with an end-of-header line. An end-of-header line looks like this: @c %**end of header If you include the `@setchapternewpage' command between the start-of-header and end-of-header lines, TeX will typeset a region as that command specifies. Similarly, if you include an `@smallbook' command between the start-of-header and end-of-header lines, TeX will typeset a region in the "small" book format. The reason for the odd string of characters (`%**') is so that the `texinfo-tex-region' command does not accidentally find something that it should not when it is looking for the header. The start-of-header line and the end-of-header line are Texinfo mode variables that you can change.  File: texinfo, Node: Info Summary and Permissions, Next: Titlepage & Copyright Page, Prev: Header, Up: Beginning a File Summary and Copying Permissions for Info ======================================== The title page and the copyright page appear only in the printed copy of the manual; therefore, the same information must be inserted in a section that appears only in the Info file. This section usually contains a brief description of the contents of the Info file, a copyright notice, and copying permissions. The copyright notice should read: Copyright YEAR COPYRIGHT-OWNER and be put on a line by itself. Standard text for the copyright permissions of free manuals is contained in an appendix to this manual (*note GNU Free Documentation License: Documentation Copying.). The permissions text appears in an Info file _before_ the first node. This mean that a reader does _not_ see this text when reading the file using Info (except when using the advanced Info command `g *').  File: texinfo, Node: Titlepage & Copyright Page, Next: The Top Node, Prev: Info Summary and Permissions, Up: Beginning a File The Title and Copyright Pages ============================= A manual's name and author are usually printed on a title page. Sometimes copyright information is printed on the title page as well; more often, copyright information is printed on the back of the title page. The title and copyright pages appear in the printed manual, but not in the Info file. Because of this, it is possible to use several slightly obscure TeX typesetting commands that cannot be used in an Info file. In addition, this part of the beginning of a Texinfo file contains the text of the copying permissions that will appear in the printed manual. You may wish to include titlepage-like information for plain text output. Simply place any such leading material between `@ifinfo' and `@end ifinfo'; `makeinfo' includes this in its plain text output. It will not show up in the Info readers. *Note GNU Free Documentation License: Documentation Copying, for the standard text for the copyright permissions. * Menu: * titlepage:: Create a title for the printed document. * titlefont center sp:: The `@titlefont', `@center', and `@sp' commands. * title subtitle author:: The `@title', `@subtitle', and `@author' commands. * Copyright & Permissions:: How to write the copyright notice and include copying permissions. * end titlepage:: Turn on page headings after the title and copyright pages. * headings on off:: An option for turning headings on and off and double or single sided printing.  File: texinfo, Node: titlepage, Next: titlefont center sp, Prev: Titlepage & Copyright Page, Up: Titlepage & Copyright Page `@titlepage' ------------ Start the material for the title page and following copyright page with `@titlepage' on a line by itself and end it with `@end titlepage' on a line by itself. The `@end titlepage' command starts a new page and turns on page numbering. (*Note Page Headings: Headings, for details about how to generate page headings.) All the material that you want to appear on unnumbered pages should be put between the `@titlepage' and `@end titlepage' commands. You can force the table of contents to appear there with the `@setcontentsaftertitlepage' command (*note Contents::). By using the `@page' command you can force a page break within the region delineated by the `@titlepage' and `@end titlepage' commands and thereby create more than one unnumbered page. This is how the copyright page is produced. (The `@titlepage' command might perhaps have been better named the `@titleandadditionalpages' command, but that would have been rather long!) When you write a manual about a computer program, you should write the version of the program to which the manual applies on the title page. If the manual changes more frequently than the program or is independent of it, you should also include an edition number(1) (*note titlepage-Footnote-1::) for the manual. This helps readers keep track of which manual is for which version of the program. (The `Top' node should also contain this information; see *Note `@top': makeinfo top.) Texinfo provides two main methods for creating a title page. One method uses the `@titlefont', `@sp', and `@center' commands to generate a title page in which the words on the page are centered. The second method uses the `@title', `@subtitle', and `@author' commands to create a title page with black rules under the title and author lines and the subtitle text set flush to the right hand side of the page. With this method, you do not specify any of the actual formatting of the title page. You specify the text you want, and Texinfo does the formatting. You may use either method, or you may combine them; see the examples in the sections below. For extremely simple applications, and for the bastard title page in traditional book front matter, Texinfo also provides a command `@shorttitlepage' which takes a single argument as the title. The argument is typeset on a page by itself and followed by a blank page.  File: texinfo, Node: titlepage-Footnotes, Up: titlepage (1) We have found that it is helpful to refer to versions of manuals as `editions' and versions of programs as `versions'; otherwise, we find we are liable to confuse each other in conversation by referring to both the documentation and the software with the same words.  File: texinfo, Node: titlefont center sp, Next: title subtitle author, Prev: titlepage, Up: Titlepage & Copyright Page `@titlefont', `@center', and `@sp' ---------------------------------- You can use the `@titlefont', `@sp', and `@center' commands to create a title page for a printed document. (This is the first of the two methods for creating a title page in Texinfo.) Use the `@titlefont' command to select a large font suitable for the title itself. You can use `@titlefont' more than once if you have an especially long title. For example: @titlefont{Texinfo} Use the `@center' command at the beginning of a line to center the remaining text on that line. Thus, @center @titlefont{Texinfo} centers the title, which in this example is "Texinfo" printed in the title font. Use the `@sp' command to insert vertical space. For example: @sp 2 This inserts two blank lines on the printed page. (*Note `@sp': sp, for more information about the `@sp' command.) A template for this method looks like this: @titlepage @sp 10 @center @titlefont{NAME-OF-MANUAL-WHEN-PRINTED} @sp 2 @center SUBTITLE-IF-ANY @sp 2 @center AUTHOR ... @end titlepage The spacing of the example fits an 8.5 by 11 inch manual.  File: texinfo, Node: title subtitle author, Next: Copyright & Permissions, Prev: titlefont center sp, Up: Titlepage & Copyright Page `@title', `@subtitle', and `@author' ------------------------------------ You can use the `@title', `@subtitle', and `@author' commands to create a title page in which the vertical and horizontal spacing is done for you automatically. This contrasts with the method described in the previous section, in which the `@sp' command is needed to adjust vertical spacing. Write the `@title', `@subtitle', or `@author' commands at the beginning of a line followed by the title, subtitle, or author. The `@title' command produces a line in which the title is set flush to the left-hand side of the page in a larger than normal font. The title is underlined with a black rule. Only a single line is allowed; the `@*' command may not be used to break the title into two lines. To handle very long titles, you may find it profitable to use both `@title' and `@titlefont'; see the final example in this section. The `@subtitle' command sets subtitles in a normal-sized font flush to the right-hand side of the page. The `@author' command sets the names of the author or authors in a middle-sized font flush to the left-hand side of the page on a line near the bottom of the title page. The names are underlined with a black rule that is thinner than the rule that underlines the title. (The black rule only occurs if the `@author' command line is followed by an `@page' command line.) There are two ways to use the `@author' command: you can write the name or names on the remaining part of the line that starts with an `@author' command: @author by Jane Smith and John Doe or you can write the names one above each other by using two (or more) `@author' commands: @author Jane Smith @author John Doe (Only the bottom name is underlined with a black rule.) A template for this method looks like this: @titlepage @title NAME-OF-MANUAL-WHEN-PRINTED @subtitle SUBTITLE-IF-ANY @subtitle SECOND-SUBTITLE @author AUTHOR @page ... @end titlepage You may also combine the `@titlefont' method described in the previous section and `@title' method described in this one. This may be useful if you have a very long title. Here is a real-life example: @titlepage @titlefont{GNU Software} @sp 1 @title for MS-Windows and MS-DOS @subtitle Edition @value{e} for Release @value{cde} @author by Daniel Hagerty, Melissa Weisshaus @author and Eli Zaretskii (The use of `@value' here is explained in *Note `@value' Example: value Example.)  File: texinfo, Node: Copyright & Permissions, Next: end titlepage, Prev: title subtitle author, Up: Titlepage & Copyright Page Copyright Page and Permissions ------------------------------ By international treaty, the copyright notice for a book should be either on the title page or on the back of the title page. The copyright notice should include the year followed by the name of the organization or person who owns the copyright. When the copyright notice is on the back of the title page, that page is customarily not numbered. Therefore, in Texinfo, the information on the copyright page should be within `@titlepage' and `@end titlepage' commands. Use the `@page' command to cause a page break. To push the copyright notice and the other text on the copyright page towards the bottom of the page, you can write a somewhat mysterious line after the `@page' command that reads like this: @vskip 0pt plus 1filll This is a TeX command that is not supported by the Info formatting commands. The `@vskip' command inserts whitespace. The `0pt plus 1filll' means to put in zero points of mandatory whitespace, and as much optional whitespace as needed to push the following text to the bottom of the page. Note the use of three `l's in the word `filll'; this is the correct usage in TeX. In a printed manual, the `@copyright{}' command generates a `c' inside a circle. (In Info, it generates `(C)'.) The copyright notice itself has the following legally defined sequence: Copyright (C) YEAR COPYRIGHT-OWNER It is customary to put information on how to get a manual after the copyright notice, followed by the copying permissions for the manual. Permissions must be given here as well as in the summary segment within `@ifinfo' and `@end ifinfo' that immediately follows the header since this text appears only in the printed manual and the `ifinfo' text appears only in the Info file. *Note GNU Free Documentation License: Documentation Copying, for the standard text.  File: texinfo, Node: end titlepage, Next: headings on off, Prev: Copyright & Permissions, Up: Titlepage & Copyright Page Heading Generation ------------------ An `@end titlepage' command on a line by itself not only marks the end of the title and copyright pages, but also causes TeX to start generating page headings and page numbers. To repeat what is said elsewhere, Texinfo has two standard page heading formats, one for documents which are printed on one side of each sheet of paper (single-sided printing), and the other for documents which are printed on both sides of each sheet (double-sided printing). (*Note `@setchapternewpage': setchapternewpage.) You can specify these formats in different ways: * The conventional way is to write an `@setchapternewpage' command before the title page commands, and then have the `@end titlepage' command start generating page headings in the manner desired. (*Note `@setchapternewpage': setchapternewpage.) * Alternatively, you can use the `@headings' command to prevent page headings from being generated or to start them for either single or double-sided printing. (Write an `@headings' command immediately after the `@end titlepage' command. *Note The `@headings' Command: headings on off, for more information.) * Or, you may specify your own page heading and footing format. *Note Page Headings: Headings, for detailed information about page headings and footings. Most documents are formatted with the standard single-sided or double-sided format, using `@setchapternewpage odd' for double-sided printing and no `@setchapternewpage' command for single-sided printing.  File: texinfo, Node: headings on off, Prev: end titlepage, Up: Titlepage & Copyright Page The `@headings' Command ----------------------- The `@headings' command is rarely used. It specifies what kind of page headings and footings to print on each page. Usually, this is controlled by the `@setchapternewpage' command. You need the `@headings' command only if the `@setchapternewpage' command does not do what you want, or if you want to turn off pre-defined page headings prior to defining your own. Write an `@headings' command immediately after the `@end titlepage' command. You can use `@headings' as follows: `@headings off' Turn off printing of page headings. `@headings single' Turn on page headings appropriate for single-sided printing. `@headings double' `@headings on' Turn on page headings appropriate for double-sided printing. The two commands, `@headings on' and `@headings double', are synonymous. `@headings singleafter' `@headings doubleafter' Turn on `single' or `double' headings, respectively, after the current page is output. `@headings on' Turn on page headings: `single' if `@setchapternewpage on', `double' otherwise. For example, suppose you write `@setchapternewpage off' before the `@titlepage' command to tell TeX to start a new chapter on the same page as the end of the last chapter. This command also causes TeX to typeset page headers for single-sided printing. To cause TeX to typeset for double sided printing, write `@headings double' after the `@end titlepage' command. You can stop TeX from generating any page headings at all by writing `@headings off' on a line of its own immediately after the line containing the `@end titlepage' command, like this: @end titlepage @headings off The `@headings off' command overrides the `@end titlepage' command, which would otherwise cause TeX to print page headings. You can also specify your own style of page heading and footing. *Note Page Headings: Headings, for more information.  File: texinfo, Node: The Top Node, Next: Software Copying Permissions, Prev: Titlepage & Copyright Page, Up: Beginning a File The `Top' Node and Master Menu ============================== The `Top' node is the node from which you enter an Info file. A `Top' node should contain a brief description of the Info file and an extensive, master menu for the whole Info file. This helps the reader understand what the Info file is about. Also, you should write the version number of the program to which the Info file applies; or, at least, the edition number. The contents of the `Top' node should appear only in the Info file; none of it should appear in printed output, so enclose it between `@ifinfo' and `@end ifinfo' commands. (TeX does not print either an `@node' line or a menu; they appear only in Info; strictly speaking, you are not required to enclose these parts between `@ifinfo' and `@end ifinfo', but it is simplest to do so. *Note Conditionally Visible Text: Conditionals.) * Menu: * Title of Top Node:: Sketch what the file is about. * Master Menu Parts:: A master menu has three or more parts.  File: texinfo, Node: Title of Top Node, Next: Master Menu Parts, Up: The Top Node `Top' Node Title ---------------- Sometimes, you will want to place an `@top' sectioning command line containing the title of the document immediately after the `@node Top' line (*note The `@top' Sectioning Command: makeinfo top command., for more information). For example, the beginning of the Top node of this manual contains an `@top' sectioning command, a short description, and edition and version information. It looks like this: ... @end titlepage @ifnottex @node Top, Copying, , (dir) @top Texinfo Texinfo is a documentation system... This is edition... ... @end ifnottex @menu * Copying:: Texinfo is freely redistributable. * Overview:: What is Texinfo? ... @end menu In a `Top' node, the `Previous', and `Up' nodes usually refer to the top level directory of the whole Info system, which is called `(dir)'. The `Next' node refers to the first node that follows the main or master menu, which is usually the copying permissions, introduction, or first chapter.  File: texinfo, Node: Master Menu Parts, Prev: Title of Top Node, Up: The Top Node Parts of a Master Menu ---------------------- A "master menu" is a detailed main menu listing all the nodes in a file. A master menu is enclosed in `@menu' and `@end menu' commands and does not appear in the printed document. Generally, a master menu is divided into parts. * The first part contains the major nodes in the Texinfo file: the nodes for the chapters, chapter-like sections, and the appendices. * The second part contains nodes for the indices. * The third and subsequent parts contain a listing of the other, lower level nodes, often ordered by chapter. This way, rather than go through an intermediary menu, an inquirer can go directly to a particular node when searching for specific information. These menu items are not required; add them if you think they are a convenience. If you do use them, put `@detailmenu' before the first one, and `@end detailmenu' after the last; otherwise, `makeinfo' will get confused. Each section in the menu can be introduced by a descriptive line. So long as the line does not begin with an asterisk, it will not be treated as a menu entry. (*Note Writing a Menu::, for more information.) For example, the master menu for this manual looks like the following (but has many more entries): @menu * Copying:: Texinfo is freely redistributable. * Overview:: What is Texinfo? * Texinfo Mode:: Special features in GNU Emacs. ... ... * Command and Variable Index:: An entry for each @-command. * Concept Index:: An entry for each concept. @detailmenu --- The Detailed Node Listing --- Overview of Texinfo * Info Files:: What is an Info file? * Printed Manuals:: Characteristics of a printed manual. ... ... Using Texinfo Mode * Info on a Region:: Formatting part of a file for Info. ... ... @end detailmenu @end menu  File: texinfo, Node: Software Copying Permissions, Prev: The Top Node, Up: Beginning a File Software Copying Permissions ============================ If the Texinfo file has a section containing the "General Public License" and the distribution information and a warranty disclaimer for the software that is documented, this section usually follows the `Top' node. The General Public License is very important to Project GNU software. It ensures that you and others will continue to have a right to use and share the software. The copying and distribution information and the disclaimer are followed by an introduction or else by the first chapter of the manual. Although an introduction is not a required part of a Texinfo file, it is very helpful. Ideally, it should state clearly and concisely what the file is about and who would be interested in reading it. In general, an introduction would follow the licensing and distribution information, although sometimes people put it earlier in the document. Usually, an introduction is put in an `@unnumbered' section. (*Note The `@unnumbered' and `@appendix' Commands: unnumbered & appendix.)  File: texinfo, Node: Ending a File, Next: Structuring, Prev: Beginning a File, Up: Top Ending a Texinfo File ********************* The end of a Texinfo file should include commands to create indices and (usually) to generate detailed and summary tables of contents. And it must include the `@bye' command that marks the last line processed by TeX. For example: @node Concept Index, , Variables Index, Top @c node-name, next, previous, up @unnumbered Concept Index @printindex cp @contents @bye * Menu: * Printing Indices & Menus:: How to print an index in hardcopy and generate index menus in Info. * Contents:: How to create a table of contents. * File End:: How to mark the end of a file.  File: texinfo, Node: Printing Indices & Menus, Next: Contents, Prev: Ending a File, Up: Ending a File Index Menus and Printing an Index ================================= To print an index means to include it as part of a manual or Info file. This does not happen automatically just because you use `@cindex' or other index-entry generating commands in the Texinfo file; those just cause the raw data for the index to be accumulated. To generate an index, you must include the `@printindex' command at the place in the document where you want the index to appear. Also, as part of the process of creating a printed manual, you must run a program called `texindex' (*note Hardcopy::) to sort the raw data to produce a sorted index file. The sorted index file is what is actually used to print the index. Texinfo offers six different types of predefined index: the concept index, the function index, the variables index, the keystroke index, the program index, and the data type index (*note Predefined Indices::). Each index type has a two-letter name: `cp', `fn', `vr', `ky', `pg', and `tp'. You may merge indices, or put them into separate sections (*note Combining Indices::); or you may define your own indices (*note Defining New Indices: New Indices.). The `@printindex' command takes a two-letter index name, reads the corresponding sorted index file and formats it appropriately into an index. The `@printindex' command does not generate a chapter heading for the index. Consequently, you should precede the `@printindex' command with a suitable section or chapter command (usually `@unnumbered') to supply the chapter heading and put the index into the table of contents. Precede the `@unnumbered' command with an `@node' line. For example: @node Variable Index, Concept Index, Function Index, Top @comment node-name, next, previous, up @unnumbered Variable Index @printindex vr @node Concept Index, , Variable Index, Top @comment node-name, next, previous, up @unnumbered Concept Index @printindex cp Readers often prefer that the concept index come last in a book, since that makes it easiest to find. Having just one index helps readers also, since then they have only one place to look (*note synindex::).  File: texinfo, Node: Contents, Next: File End, Prev: Printing Indices & Menus, Up: Ending a File Generating a Table of Contents ============================== The `@chapter', `@section', and other structuring commands supply the information to make up a table of contents, but they do not cause an actual table to appear in the manual. To do this, you must use the `@contents' and/or `@summarycontents' command(s). `@contents' Generate a table of contents in a printed manual, including all chapters, sections, subsections, etc., as well as appendices and unnumbered chapters. (Headings generated by the `@heading' series of commands do not appear in the table of contents.) `@shortcontents' `@summarycontents' (`@summarycontents' is a synonym for `@shortcontents'; the two commands are exactly the same.) Generate a short or summary table of contents that lists only the chapters (and appendices and unnumbered chapters). Omit sections, subsections and subsubsections. Only a long manual needs a short table of contents in addition to the full table of contents. Both contents commands should be written on a line by themselves. The contents commands automatically generate a chapter-like heading at the top of the first table of contents page, so don't include any sectioning command such as `@unnumbered' before them. Since an Info file uses menus instead of tables of contents, the Info formatting commands ignore the contents commands. But the contents are included in plain text output (generated by `makeinfo --no-headers'), unless `makeinfo' is writing its output to standard output. When `makeinfo' writes a short table of contents while producing html output, the links in the short table of contents point to corresponding entries in the full table of contents rather than the text of the document. The links in the full table of contents point to the main text of the document. The contents commands can be placed either at the very end of the file, after any indices (see the previous section) and just before the `@bye' (see the next section), or near the beginning of the file, after the `@end titlepage' (*note titlepage::). The advantage to the former is that then the contents output is always up to date, because it reflects the processing just done. The advantage to the latter is that the contents are printed in the proper place, thus you do not need to rearrange the DVI file with `dviselect' or shuffle paper. As an author, you can put the contents commands wherever you prefer. But if you are a user simply printing a manual, you may wish to print the contents after the title page even if the author put the contents commands at the end of the document (as is the case in most existing Texinfo documents). You can do this by specifying `@setcontentsaftertitlepage' and/or `@setshortcontentsaftertitlepage'. The first prints only the main contents after the `@end titlepage'; the second prints both the short contents and the main contents. In either case, any subsequent `@contents' or `@shortcontents' is ignored (unless no `@end titlepage' is ever encountered). You need to include the `@set...contentsaftertitlepage' commands early in the document (just after `@setfilename', for example). Or, if you're using `texi2dvi' (*note Format with texi2dvi::), you can use its `--texinfo' option to specify this without altering the source file at all. For example: texi2dvi --texinfo=@setshortcontentsaftertitlepage foo.texi  File: texinfo, Node: File End, Prev: Contents, Up: Ending a File `@bye' File Ending ================== An `@bye' command terminates TeX or Info formatting. None of the formatting commands see any of the file following `@bye'. The `@bye' command should be on a line by itself. If you wish, you may follow the `@bye' line with notes. These notes will not be formatted and will not appear in either Info or a printed manual; it is as if text after `@bye' were within `@ignore' ... `@end ignore'. Also, you may follow the `@bye' line with a local variables list. *Note Using Local Variables and the Compile Command: Compile-Command, for more information.  File: texinfo, Node: Structuring, Next: Nodes, Prev: Ending a File, Up: Top Chapter Structuring ******************* The "chapter structuring" commands divide a document into a hierarchy of chapters, sections, subsections, and subsubsections. These commands generate large headings; they also provide information for the table of contents of a printed manual (*note Generating a Table of Contents: Contents.). The chapter structuring commands do not create an Info node structure, so normally you should put an `@node' command immediately before each chapter structuring command (*note Nodes::). The only time you are likely to use the chapter structuring commands without using the node structuring commands is if you are writing a document that contains no cross references and will never be transformed into Info format. It is unlikely that you will ever write a Texinfo file that is intended only as an Info file and not as a printable document. If you do, you might still use chapter structuring commands to create a heading at the top of each node--but you don't need to. * Menu: * Tree Structuring:: A manual is like an upside down tree ... * Structuring Command Types:: How to divide a manual into parts. * makeinfo top:: The `@top' command, part of the `Top' node. * chapter:: * unnumbered & appendix:: * majorheading & chapheading:: * section:: * unnumberedsec appendixsec heading:: * subsection:: * unnumberedsubsec appendixsubsec subheading:: * subsubsection:: Commands for the lowest level sections. * Raise/lower sections:: How to change commands' hierarchical level.  File: texinfo, Node: Tree Structuring, Next: Structuring Command Types, Up: Structuring Tree Structure of Sections ========================== A Texinfo file is usually structured like a book with chapters, sections, subsections, and the like. This structure can be visualized as a tree (or rather as an upside-down tree) with the root at the top and the levels corresponding to chapters, sections, subsection, and subsubsections. Here is a diagram that shows a Texinfo file with three chapters, each of which has two sections. Top | ------------------------------------- | | | Chapter 1 Chapter 2 Chapter 3 | | | -------- -------- -------- | | | | | | Section Section Section Section Section Section 1.1 1.2 2.1 2.2 3.1 3.2 In a Texinfo file that has this structure, the beginning of Chapter 2 looks like this: @node Chapter 2, Chapter 3, Chapter 1, top @chapter Chapter 2 The chapter structuring commands are described in the sections that follow; the `@node' and `@menu' commands are described in following chapters. (*Note Nodes::, and see *Note Menus::.)  File: texinfo, Node: Structuring Command Types, Next: makeinfo top, Prev: Tree Structuring, Up: Structuring Structuring Command Types ========================= The chapter structuring commands fall into four groups or series, each of which contains structuring commands corresponding to the hierarchical levels of chapters, sections, subsections, and subsubsections. The four groups are the `@chapter' series, the `@unnumbered' series, the `@appendix' series, and the `@heading' series. Each command produces titles that have a different appearance on the printed page or Info file; only some of the commands produce titles that are listed in the table of contents of a printed book or manual. * The `@chapter' and `@appendix' series of commands produce numbered or lettered entries both in the body of a printed work and in its table of contents. * The `@unnumbered' series of commands produce unnumbered entries both in the body of a printed work and in its table of contents. The `@top' command, which has a special use, is a member of this series (*note `@top': makeinfo top.). * The `@heading' series of commands produce unnumbered headings that do not appear in a table of contents. The heading commands never start a new page. * The `@majorheading' command produces results similar to using the `@chapheading' command but generates a larger vertical whitespace before the heading. * When an `@setchapternewpage' command says to do so, the `@chapter', `@unnumbered', and `@appendix' commands start new pages in the printed manual; the `@heading' commands do not. Here are the four groups of chapter structuring commands: No new page Numbered Unnumbered Lettered/numbered Unnumbered In contents In contents In contents Omitted from contents `@top' `@majorheading' `@chapter' `@unnumbered' `@appendix' `@chapheading' `@section' `@unnumberedsec' `@appendixsec' `@heading' `@subsection' `@unnumberedsubsec' `@appendixsubsec' `@subheading' `@subsubsection'`@unnumberedsubsubsec' `@appendixsubsubsec' `@subsubheading'  File: texinfo, Node: makeinfo top, Next: chapter, Prev: Structuring Command Types, Up: Structuring `@top' ====== The `@top' command is a special sectioning command that you use only after an `@node Top' line at the beginning of a Texinfo file. The `@top' command tells the `makeinfo' formatter which node is the `Top' node, so it can use it as the root of the node tree if your manual uses implicit pointers. It has the same typesetting effect as `@unnumbered' (*note `@unnumbered' and `@appendix': unnumbered & appendix.). For detailed information, see *Note The `@top' Command: makeinfo top command. The `@top' node and its menu (if any) is conventionally wrapped in an `@ifnottex' conditional so that it will appear only in Info and HTML output, not TeX.  File: texinfo, Node: chapter, Next: unnumbered & appendix, Prev: makeinfo top, Up: Structuring `@chapter' ========== `@chapter' identifies a chapter in the document. Write the command at the beginning of a line and follow it on the same line by the title of the chapter. For example, this chapter in this manual is entitled "Chapter Structuring"; the `@chapter' line looks like this: @chapter Chapter Structuring In TeX, the `@chapter' command creates a chapter in the document, specifying the chapter title. The chapter is numbered automatically. In Info, the `@chapter' command causes the title to appear on a line by itself, with a line of asterisks inserted underneath. Thus, in Info, the above example produces the following output: Chapter Structuring ******************* Texinfo also provides a command `@centerchap', which is analogous to `@unnumbered', but centers its argument in the printed output. This kind of stylistic choice is not usually offered by Texinfo.  File: texinfo, Node: unnumbered & appendix, Next: majorheading & chapheading, Prev: chapter, Up: Structuring `@unnumbered' and `@appendix' ============================= Use the `@unnumbered' command to create a chapter that appears in a printed manual without chapter numbers of any kind. Use the `@appendix' command to create an appendix in a printed manual that is labelled by letter instead of by number. For Info file output, the `@unnumbered' and `@appendix' commands are equivalent to `@chapter': the title is printed on a line by itself with a line of asterisks underneath. (*Note `@chapter': chapter.) To create an appendix or an unnumbered chapter, write an `@appendix' or `@unnumbered' command at the beginning of a line and follow it on the same line by the title, as you would if you were creating a chapter.  File: texinfo, Node: majorheading & chapheading, Next: section, Prev: unnumbered & appendix, Up: Structuring `@majorheading', `@chapheading' =============================== The `@majorheading' and `@chapheading' commands put chapter-like headings in the body of a document. However, neither command causes TeX to produce a numbered heading or an entry in the table of contents; and neither command causes TeX to start a new page in a printed manual. In TeX, an `@majorheading' command generates a larger vertical whitespace before the heading than an `@chapheading' command but is otherwise the same. In Info, the `@majorheading' and `@chapheading' commands are equivalent to `@chapter': the title is printed on a line by itself with a line of asterisks underneath. (*Note `@chapter': chapter.)  File: texinfo, Node: section, Next: unnumberedsec appendixsec heading, Prev: majorheading & chapheading, Up: Structuring `@section' ========== In a printed manual, an `@section' command identifies a numbered section within a chapter. The section title appears in the table of contents. In Info, an `@section' command provides a title for a segment of text, underlined with `='. This section is headed with an `@section' command and looks like this in the Texinfo file: @section @code{@@section} To create a section, write the `@section' command at the beginning of a line and follow it on the same line by the section title. Thus, @section This is a section produces This is a section ================= in Info. bsec appendixsubsec subheading:: * subsubsection:: Commands for the lowest level sections. * Raise/lower sections:: How to change commands' hierarchical level.  File: texinfo, Node: Tree Structuring, Next: Structuring Command Types, Up: Structuring Tree Structure of Sections ========================== A Texinfo file is usually structured like a book with chapters, s./info/texinfo-4 644 0 0 141210 7442531461 6702 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: unnumberedsec appendixsec heading, Next: subsection, Prev: section, Up: Structuring `@unnumberedsec', `@appendixsec', `@heading' ============================================ The `@unnumberedsec', `@appendixsec', and `@heading' commands are, respectively, the unnumbered, appendix-like, and heading-like equivalents of the `@section' command. (*Note `@section': section.) `@unnumberedsec' The `@unnumberedsec' command may be used within an unnumbered chapter or within a regular chapter or appendix to provide an unnumbered section. `@appendixsec' `@appendixsection' `@appendixsection' is a longer spelling of the `@appendixsec' command; the two are synonymous. Conventionally, the `@appendixsec' or `@appendixsection' command is used only within appendices. `@heading' You may use the `@heading' command anywhere you wish for a section-style heading that will not appear in the table of contents.  File: texinfo, Node: subsection, Next: unnumberedsubsec appendixsubsec subheading, Prev: unnumberedsec appendixsec heading, Up: Structuring The `@subsection' Command ========================= Subsections are to sections as sections are to chapters. (*Note `@section': section.) In Info, subsection titles are underlined with `-'. For example, @subsection This is a subsection produces This is a subsection -------------------- In a printed manual, subsections are listed in the table of contents and are numbered three levels deep.  File: texinfo, Node: unnumberedsubsec appendixsubsec subheading, Next: subsubsection, Prev: subsection, Up: Structuring The `@subsection'-like Commands =============================== The `@unnumberedsubsec', `@appendixsubsec', and `@subheading' commands are, respectively, the unnumbered, appendix-like, and heading-like equivalents of the `@subsection' command. (*Note `@subsection': subsection.) In Info, the `@subsection'-like commands generate a title underlined with hyphens. In a printed manual, an `@subheading' command produces a heading like that of a subsection except that it is not numbered and does not appear in the table of contents. Similarly, an `@unnumberedsubsec' command produces an unnumbered heading like that of a subsection and an `@appendixsubsec' command produces a subsection-like heading labelled with a letter and numbers; both of these commands produce headings that appear in the table of contents.  File: texinfo, Node: subsubsection, Next: Raise/lower sections, Prev: unnumberedsubsec appendixsubsec subheading, Up: Structuring The `subsub' Commands ===================== The fourth and lowest level sectioning commands in Texinfo are the `subsub' commands. They are: `@subsubsection' Subsubsections are to subsections as subsections are to sections. (*Note `@subsection': subsection.) In a printed manual, subsubsection titles appear in the table of contents and are numbered four levels deep. `@unnumberedsubsubsec' Unnumbered subsubsection titles appear in the table of contents of a printed manual, but lack numbers. Otherwise, unnumbered subsubsections are the same as subsubsections. In Info, unnumbered subsubsections look exactly like ordinary subsubsections. `@appendixsubsubsec' Conventionally, appendix commands are used only for appendices and are lettered and numbered appropriately in a printed manual. They also appear in the table of contents. In Info, appendix subsubsections look exactly like ordinary subsubsections. `@subsubheading' The `@subsubheading' command may be used anywhere that you need a small heading that will not appear in the table of contents. In Info, subsubheadings look exactly like ordinary subsubsection headings. In Info, `subsub' titles are underlined with periods. For example, @subsubsection This is a subsubsection produces This is a subsubsection .......................  File: texinfo, Node: Raise/lower sections, Prev: subsubsection, Up: Structuring `@raisesections' and `@lowersections' ===================================== The `@raisesections' and `@lowersections' commands raise and lower the hierarchical level of chapters, sections, subsections and the like. The `@raisesections' command changes sections to chapters, subsections to sections, and so on. The `@lowersections' command changes chapters to sections, sections to subsections, and so on. An `@lowersections' command is useful if you wish to include text that is written as an outer or standalone Texinfo file in another Texinfo file as an inner, included file. If you write the command at the beginning of the file, all your `@chapter' commands are formatted as if they were `@section' commands, all your `@section' command are formatted as if they were `@subsection' commands, and so on. `@raisesections' raises a command one level in the chapter structuring hierarchy: Change To @subsection @section, @section @chapter, @heading @chapheading, etc. `@lowersections' lowers a command one level in the chapter structuring hierarchy: Change To @chapter @section, @subsection @subsubsection, @heading @subheading, etc. An `@raisesections' or `@lowersections' command changes only those structuring commands that follow the command in the Texinfo file. Write an `@raisesections' or `@lowersections' command on a line of its own. An `@lowersections' command cancels an `@raisesections' command, and vice versa. Typically, the commands are used like this: @lowersections @include somefile.texi @raisesections Without the `@raisesections', all the subsequent sections in your document will be lowered. Repeated use of the commands continue to raise or lower the hierarchical level a step at a time. An attempt to raise above `chapters' reproduces chapter commands; an attempt to lower below `subsubsections' reproduces subsubsection commands.  File: texinfo, Node: Nodes, Next: Menus, Prev: Structuring, Up: Top Nodes ***** "Nodes" are the primary segments of a Texinfo file. They do not themselves impose a hierarchical or any other kind of structure on a file. Nodes contain "node pointers" that name other nodes, and can contain "menus" which are lists of nodes. In Info, the movement commands can carry you to a pointed-to node or to a node listed in a menu. Node pointers and menus provide structure for Info files just as chapters, sections, subsections, and the like, provide structure for printed books. * Menu: * Two Paths:: Different commands to structure Info output and printed output. * Node Menu Illustration:: A diagram, and sample nodes and menus. * node:: Creating nodes, in detail. * makeinfo Pointer Creation:: Letting makeinfo determine node pointers. * anchor:: Defining arbitrary cross-reference targets.  File: texinfo, Node: Two Paths, Next: Node Menu Illustration, Up: Nodes Two Paths ========= The node and menu commands and the chapter structuring commands are technically independent of each other: * In Info, node and menu commands provide structure. The chapter structuring commands generate headings with different kinds of underlining--asterisks for chapters, hyphens for sections, and so on; they do nothing else. * In TeX, the chapter structuring commands generate chapter and section numbers and tables of contents. The node and menu commands provide information for cross references; they do nothing else. You can use node pointers and menus to structure an Info file any way you want; and you can write a Texinfo file so that its Info output has a different structure than its printed output. However, virtually all Texinfo files are written such that the structure for the Info output corresponds to the structure for the printed output. It is neither convenient nor understandable to the reader to do otherwise. Generally, printed output is structured in a tree-like hierarchy in which the chapters are the major limbs from which the sections branch out. Similarly, node pointers and menus are organized to create a matching structure in the Info output.  File: texinfo, Node: Node Menu Illustration, Next: node, Prev: Two Paths, Up: Nodes Node and Menu Illustration ========================== Here is a copy of the diagram shown earlier that illustrates a Texinfo file with three chapters, each of which contains two sections. The "root" is at the top of the diagram and the "leaves" are at the bottom. This is how such a diagram is drawn conventionally; it illustrates an upside-down tree. For this reason, the root node is called the `Top' node, and `Up' node pointers carry you closer to the root. Top | ------------------------------------- | | | Chapter 1 Chapter 2 Chapter 3 | | | -------- -------- -------- | | | | | | Section Section Section Section Section Section 1.1 1.2 2.1 2.2 3.1 3.2 The fully-written command to start Chapter 2 would be this: @node Chapter 2, Chapter 3, Chapter 1, Top @comment node-name, next, previous, up This `@node' line says that the name of this node is "Chapter 2", the name of the `Next' node is "Chapter 3", the name of the `Previous' node is "Chapter 1", and the name of the `Up' node is "Top". You can omit writing out these node names if your document is hierarchically organized (*note makeinfo Pointer Creation::), but the pointer relationships still obtain. *Please Note:* `Next' refers to the next node at the same hierarchical level in the manual, not necessarily to the next node within the Texinfo file. In the Texinfo file, the subsequent node may be at a lower level--a section-level node most often follows a chapter-level node, for example. `Next' and `Previous' refer to nodes at the _same_ hierarchical level. (The `Top' node contains the exception to this rule. Since the `Top' node is the only node at that level, `Next' refers to the first following node, which is almost always a chapter or chapter-level node.) To go to Sections 2.1 and 2.2 using Info, you need a menu inside Chapter 2. (*Note Menus::.) You would write the menu just before the beginning of Section 2.1, like this: @menu * Sect. 2.1:: Description of this section. * Sect. 2.2:: @end menu Write the node for Sect. 2.1 like this: @node Sect. 2.1, Sect. 2.2, Chapter 2, Chapter 2 @comment node-name, next, previous, up In Info format, the `Next' and `Previous' pointers of a node usually lead to other nodes at the same level--from chapter to chapter or from section to section (sometimes, as shown, the `Previous' pointer points up); an `Up' pointer usually leads to a node at the level above (closer to the `Top' node); and a `Menu' leads to nodes at a level below (closer to `leaves'). (A cross reference can point to a node at any level; see *Note Cross References::.) Usually, an `@node' command and a chapter structuring command are used in sequence, along with indexing commands. (You may follow the `@node' line with a comment line that reminds you which pointer is which.) Here is the beginning of the chapter in this manual called "Ending a Texinfo File". This shows an `@node' line followed by a comment line, an `@chapter' line, and then by indexing lines. @node Ending a File, Structuring, Beginning a File, Top @comment node-name, next, previous, up @chapter Ending a Texinfo File @cindex Ending a Texinfo file @cindex Texinfo file ending @cindex File ending  File: texinfo, Node: node, Next: makeinfo Pointer Creation, Prev: Node Menu Illustration, Up: Nodes The `@node' Command =================== A "node" is a segment of text that begins at an `@node' command and continues until the next `@node' command. The definition of node is different from that for chapter or section. A chapter may contain sections and a section may contain subsections; but a node cannot contain subnodes; the text of a node continues only until the next `@node' command in the file. A node usually contains only one chapter structuring command, the one that follows the `@node' line. On the other hand, in printed output nodes are used only for cross references, so a chapter or section may contain any number of nodes. Indeed, a chapter usually contains several nodes, one for each section, subsection, and subsubsection. To create a node, write an `@node' command at the beginning of a line, and follow it with up to four arguments, separated by commas, on the rest of the same line. The first argument is required; it is the name of this node. The subsequent arguments are the names of the `Next', `Previous', and `Up' pointers, in that order, and may be omitted if your Texinfo document is hierarchically organized (*note makeinfo Pointer Creation::). You may insert spaces before each name if you wish; the spaces are ignored. You must write the name of the node and the names of the `Next', `Previous', and `Up' pointers all on the same line. Otherwise, the formatters fail. (*note info: (info)Top, for more information about nodes in Info.) Usually, you write one of the chapter-structuring command lines immediately after an `@node' line--for example, an `@section' or `@subsection' line. (*Note Structuring Command Types::.) *Please note:* The GNU Emacs Texinfo mode updating commands work only with Texinfo files in which `@node' lines are followed by chapter structuring lines. *Note Updating Requirements::. TeX uses `@node' lines to identify the names to use for cross references. For this reason, you must write `@node' lines in a Texinfo file that you intend to format for printing, even if you do not intend to format it for Info. (Cross references, such as the one at the end of this sentence, are made with `@xref' and related commands; see *Note Cross References::.) * Menu: * Node Names:: How to choose node and pointer names. * Writing a Node:: How to write an `@node' line. * Node Line Tips:: Keep names short. * Node Line Requirements:: Keep names unique, without @-commands. * First Node:: How to write a `Top' node. * makeinfo top command:: How to use the `@top' command. * Top Node Summary:: Write a brief description for readers.  File: texinfo, Node: Node Names, Next: Writing a Node, Up: node Choosing Node and Pointer Names ------------------------------- The name of a node identifies the node. The pointers enable you to reach other nodes and consist of the names of those nodes. Normally, a node's `Up' pointer contains the name of the node whose menu mentions that node. The node's `Next' pointer contains the name of the node that follows that node in that menu and its `Previous' pointer contains the name of the node that precedes it in that menu. When a node's `Previous' node is the same as its `Up' node, both node pointers name the same node. Usually, the first node of a Texinfo file is the `Top' node, and its `Up' and `Previous' pointers point to the `dir' file, which contains the main menu for all of Info. The `Top' node itself contains the main or master menu for the manual. Also, it is helpful to include a brief description of the manual in the `Top' node. *Note First Node::, for information on how to write the first node of a Texinfo file. Even when you explicitly specify all pointers, that does not mean you can write the nodes in the Texinfo source file in an arbitrary order! Because TeX processes the file sequentially, irrespective of node pointers, you must write the nodes in the order you wish them to appear in the printed output.  File: texinfo, Node: Writing a Node, Next: Node Line Tips, Prev: Node Names, Up: node How to Write an `@node' Line ---------------------------- The easiest way to write an `@node' line is to write `@node' at the beginning of a line and then the name of the node, like this: @node NODE-NAME If you are using GNU Emacs, you can use the update node commands provided by Texinfo mode to insert the names of the pointers; or you can leave the pointers out of the Texinfo file and let `makeinfo' insert node pointers into the Info file it creates. (*Note Texinfo Mode::, and *Note makeinfo Pointer Creation::.) Alternatively, you can insert the `Next', `Previous', and `Up' pointers yourself. If you do this, you may find it helpful to use the Texinfo mode keyboard command `C-c C-c n'. This command inserts `@node' and a comment line listing the names of the pointers in their proper order. The comment line helps you keep track of which arguments are for which pointers. This comment line is especially useful if you are not familiar with Texinfo. The template for a fully-written-out node line with `Next', `Previous', and `Up' pointers looks like this: @node NODE-NAME, NEXT, PREVIOUS, UP If you wish, you can ignore `@node' lines altogether in your first draft and then use the `texinfo-insert-node-lines' command to create `@node' lines for you. However, we do not recommend this practice. It is better to name the node itself at the same time that you write a segment so you can easily make cross references. A large number of cross references are an especially important feature of a good Info file. After you have inserted an `@node' line, you should immediately write an @-command for the chapter or section and insert its name. Next (and this is important!), put in several index entries. Usually, you will find at least two and often as many as four or five ways of referring to the node in the index. Use them all. This will make it much easier for people to find the node.  File: texinfo, Node: Node Line Tips, Next: Node Line Requirements, Prev: Writing a Node, Up: node `@node' Line Tips ----------------- Here are three suggestions: * Try to pick node names that are informative but short. In the Info file, the file name, node name, and pointer names are all inserted on one line, which may run into the right edge of the window. (This does not cause a problem with Info, but is ugly.) * Try to pick node names that differ from each other near the beginnings of their names. This way, it is easy to use automatic name completion in Info. * By convention, node names are capitalized just as they would be for section or chapter titles--initial and significant words are capitalized; others are not.  File: texinfo, Node: Node Line Requirements, Next: First Node, Prev: Node Line Tips, Up: node `@node' Line Requirements ------------------------- Here are several requirements for `@node' lines: * All the node names for a single Info file must be unique. Duplicates confuse the Info movement commands. This means, for example, that if you end every chapter with a summary, you must name each summary node differently. You cannot just call each one "Summary". You may, however, duplicate the titles of chapters, sections, and the like. Thus you can end each chapter in a book with a section called "Summary", so long as the node names for those sections are all different. * A pointer name must be the name of a node. The node to which a pointer points may come before or after the node containing the pointer. * @-commands used in node names generally confuse Info, so you should avoid them. This includes punctuation characters that are escaped with a `@', such as `@' and `{'. For a few rare cases when this is useful, Texinfo has limited support for using @-commands in node names; see *Note Pointer Validation::. Thus, the beginning of the section called `@chapter' looks like this: @node chapter, unnumbered & appendix, makeinfo top, Structuring @comment node-name, next, previous, up @section @code{@@chapter} @findex chapter * You cannot use parentheses in node names, because a node name such as `(foo)bar' is interpreted by the Info readers as a node `bar' in an Info file `foo'. * Unfortunately, you cannot use periods, commas, colons or apostrophes within a node name; these confuse TeX or the Info formatters. For example, the following is a section title: @code{@@unnumberedsec}, @code{@@appendixsec}, @code{@@heading} The corresponding node name is: unnumberedsec appendixsec heading * Case is significant.  File: texinfo, Node: First Node, Next: makeinfo top command, Prev: Node Line Requirements, Up: node The First Node -------------- The first node of a Texinfo file is the "Top" node, except in an included file (*note Include Files::). The Top node contains the main or master menu for the document, and a short summary of the document (*note Top Node Summary::). The Top node (which must be named `top' or `Top') should have as its `Up' node the name of a node in another file, where there is a menu that leads to this file. Specify the file name in parentheses. If the file is to be installed directly in the Info directory file, use `(dir)' as the parent of the Top node; this is short for `(dir)top', and specifies the Top node in the `dir' file, which contains the main menu for the Info system as a whole. For example, the `@node Top' line of this manual looks like this: @node Top, Copying, , (dir) (You can use the Texinfo updating commands or the `makeinfo' utility to insert these pointers automatically.) Do not define the `Previous' node of the Top node to be `(dir)', as it causes confusing behavior for users: if you are in the Top node and hits to go backwards, you wind up in the middle of the some other entry in the `dir' file, which has nothing to do with what you were reading. *Note Installing an Info File::, for more information about installing an Info file in the `info' directory.  File: texinfo, Node: makeinfo top command, Next: Top Node Summary, Prev: First Node, Up: node The `@top' Sectioning Command ----------------------------- A special sectioning command, `@top', has been created for use with the `@node Top' line. The `@top' sectioning command tells `makeinfo' that it marks the `Top' node in the file. It provides the information that `makeinfo' needs to insert node pointers automatically. Write the `@top' command at the beginning of the line immediately following the `@node Top' line. Write the title on the remaining part of the same line as the `@top' command. In Info, the `@top' sectioning command causes the title to appear on a line by itself, with a line of asterisks inserted underneath. In TeX and `texinfo-format-buffer', the `@top' sectioning command is merely a synonym for `@unnumbered'. Neither of these formatters require an `@top' command, and do nothing special with it. You can use `@chapter' or `@unnumbered' after the `@node Top' line when you use these formatters. Also, you can use `@chapter' or `@unnumbered' when you use the Texinfo updating commands to create or update pointers and menus.  File: texinfo, Node: Top Node Summary, Prev: makeinfo top command, Up: node The `Top' Node Summary ---------------------- You can help readers by writing a summary in the `Top' node, after the `@top' line, before the main or master menu. The summary should briefly describe the document. In Info, this summary will appear just before the master menu. In a printed manual, this summary will appear on a page of its own. If you do not want the summary to appear on a page of its own in a printed manual, you can enclose the whole of the `Top' node, including the `@node Top' line and the `@top' sectioning command line or other sectioning command line between `@ifinfo' and `@end ifinfo'. This prevents any of the text from appearing in the printed output. (*note Conditionally Visible Text: Conditionals.). You can repeat the brief description from the `Top' node within `@iftex' ... `@end iftex' at the beginning of the first chapter, for those who read the printed manual. This saves paper and may look neater. You should write the version number of the program to which the manual applies in the summary. This helps the reader keep track of which manual is for which version of the program. If the manual changes more frequently than the program or is independent of it, you should also include an edition number for the manual. (The title page should also contain this information: see *Note `@titlepage': titlepage.)  File: texinfo, Node: makeinfo Pointer Creation, Next: anchor, Prev: node, Up: Nodes Creating Pointers with `makeinfo' ================================= The `makeinfo' program has a feature for automatically defining node pointers for a hierarchically organized file. When you take advantage of this feature, you do not need to write the `Next', `Previous', and `Up' pointers after the name of a node. However, you must write a sectioning command, such as `@chapter' or `@section', on the line immediately following each truncated `@node' line (except that comment lines may intervene). In addition, you must follow the `Top' `@node' line with a line beginning with `@top' to mark the `Top' node in the file. *Note `@top': makeinfo top. Finally, you must write the name of each node (except for the `Top' node) in a menu that is one or more hierarchical levels above the node's hierarchical level. This node pointer insertion feature in `makeinfo' relieves you from the need to update menus and pointers manually or with Texinfo mode commands. (*Note Updating Nodes and Menus::.) In most cases, you will want to take advantage of this feature and not redundantly specify node pointers. However, Texinfo documents are not required to be organized hierarchically or in fact contain sectioning commands at all. For example, if you never intend the document to be printed. In those cases, you will need to explicitly specify the pointers.  File: texinfo, Node: anchor, Prev: makeinfo Pointer Creation, Up: Nodes `@anchor': Defining Arbitrary Cross-reference Targets ===================================================== An "anchor" is a position in your document, labeled so that cross-references can refer to it, just as they can to nodes. You create an anchor with the `@anchor' command, and give the label as a normal brace-delimited argument. For example: This marks the @anchor{x-spot}spot. ... @xref{x-spot,,the spot}. produces: This marks the spot. ... See [the spot], page 1. As you can see, the `@anchor' command itself produces no output. This example defines an anchor `x-spot' just before the word `spot'. You can refer to it later with an `@xref' or other cross-reference command, as shown. *Note Cross References::, for details on the cross-reference commands. It is best to put `@anchor' commands just before the position you wish to refer to; that way, the reader's eye is led on to the correct text when they jump to the anchor. You can put the `@anchor' command on a line by itself if that helps readability of the source. Spaces are always ignored after `@anchor'. Anchor names and node names may not conflict. Anchors and nodes are given similar treatment in some ways; for example, the `goto-node' command in standalone Info takes either an anchor name or a node name as an argument. (*Note goto-node: (info-stnd)goto-node.)  File: texinfo, Node: Menus, Next: Cross References, Prev: Nodes, Up: Top Menus ***** "Menus" contain pointers to subordinate nodes.(1) (*note Menus-Footnote-1::) In Info, you use menus to go to such nodes. Menus have no effect in printed manuals and do not appear in them. By convention, a menu is put at the end of a node since a reader who uses the menu may not see text that follows it. Furthermore, a node that has a menu should not contain much text. If you have a lot of text and a menu, move most of the text into a new subnode--all but a few lines. Otherwise, a reader with a terminal that displays only a few lines may miss the menu and its associated text. As a practical matter, you should locate a menu within 20 lines of the beginning of the node. * Menu: * Menu Location:: Put a menu in a short node. * Writing a Menu:: What is a menu? * Menu Parts:: A menu entry has three parts. * Less Cluttered Menu Entry:: Two part menu entry. * Menu Example:: Two and three part menu entries. * Other Info Files:: How to refer to a different Info file.  File: texinfo, Node: Menus-Footnotes, Up: Menus (1) Menus can carry you to any node, regardless of the hierarchical structure; even to nodes in a different Info file. However, the GNU Emacs Texinfo mode updating commands work only to create menus of subordinate nodes. Conventionally, cross references are used to refer to other nodes.  File: texinfo, Node: Menu Location, Next: Writing a Menu, Prev: Menus, Up: Menus Menus Need Short Nodes ====================== The short text before a menu may look awkward in a printed manual. To avoid this, you can write a menu near the beginning of its node and follow the menu by an `@node' line, and then an `@heading' line located within `@ifinfo' and `@end ifinfo'. This way, the menu, `@node' line, and title appear only in the Info file, not the printed document. For example, the preceding two paragraphs follow an Info-only menu, `@node' line, and heading, and look like this: @menu * Menu Location:: Put a menu in a short node. * Writing a Menu:: What is a menu? * Menu Parts:: A menu entry has three parts. * Less Cluttered Menu Entry:: Two part menu entry. * Menu Example:: Two and three part entries. * Other Info Files:: How to refer to a different Info file. @end menu @node Menu Location, Writing a Menu, , Menus @ifinfo @heading Menus Need Short Nodes @end ifinfo The Texinfo file for this document contains more than a dozen examples of this procedure. One is at the beginning of this chapter; another is at the beginning of *Note Cross References::.  File: texinfo, Node: Writing a Menu, Next: Menu Parts, Prev: Menu Location, Up: Menus Writing a Menu ============== A menu consists of an `@menu' command on a line by itself followed by menu entry lines or menu comment lines and then by an `@end menu' command on a line by itself. A menu looks like this: @menu Larger Units of Text * Files:: All about handling files. * Multiples: Buffers. Multiple buffers; editing several files at once. @end menu In a menu, every line that begins with an `* ' is a "menu entry". (Note the space after the asterisk.) A line that does not start with an `* ' may also appear in a menu. Such a line is not a menu entry but is a menu comment line that appears in the Info file. In the example above, the line `Larger Units of Text' is a menu comment line; the two lines starting with `* ' are menu entries. Space characters in a menu are preserved as-is; this allows you to format the menu as you wish.  File: texinfo, Node: Menu Parts, Next: Less Cluttered Menu Entry, Prev: Writing a Menu, Up: Menus The Parts of a Menu =================== A menu entry has three parts, only the second of which is required: 1. The menu entry name (optional). 2. The name of the node (required). 3. A description of the item (optional). The template for a menu entry looks like this: * MENU-ENTRY-NAME: NODE-NAME. DESCRIPTION Follow the menu entry name with a single colon and follow the node name with tab, comma, period, or newline. In Info, a user selects a node with the `m' (`Info-menu') command. The menu entry name is what the user types after the `m' command. The third part of a menu entry is a descriptive phrase or sentence. Menu entry names and node names are often short; the description explains to the reader what the node is about. A useful description complements the node name rather than repeats it. The description, which is optional, can spread over two or more lines; if it does, some authors prefer to indent the second line while others prefer to align it with the first (and all others). It's up to you.  File: texinfo, Node: Less Cluttered Menu Entry, Next: Menu Example, Prev: Menu Parts, Up: Menus Less Cluttered Menu Entry ========================= When the menu entry name and node name are the same, you can write the name immediately after the asterisk and space at the beginning of the line and follow the name with two colons. For example, write * Name:: DESCRIPTION instead of * Name: Name. DESCRIPTION You should use the node name for the menu entry name whenever possible, since it reduces visual clutter in the menu.  File: texinfo, Node: Menu Example, Next: Other Info Files, Prev: Less Cluttered Menu Entry, Up: Menus A Menu Example ============== A menu looks like this in Texinfo: @menu * menu entry name: Node name. A short description. * Node name:: This form is preferred. @end menu This produces: * menu: * menu entry name: Node name. A short description. * Node name:: This form is preferred. Here is an example as you might see it in a Texinfo file: @menu Larger Units of Text * Files:: All about handling files. * Multiples: Buffers. Multiple buffers; editing several files at once. @end menu This produces: * menu: Larger Units of Text * Files:: All about handling files. * Multiples: Buffers. Multiple buffers; editing several files at once. In this example, the menu has two entries. `Files' is both a menu entry name and the name of the node referred to by that name. `Multiples' is the menu entry name; it refers to the node named `Buffers'. The line `Larger Units of Text' is a comment; it appears in the menu, but is not an entry. Since no file name is specified with either `Files' or `Buffers', they must be the names of nodes in the same Info file (*note Referring to Other Info Files: Other Info Files.).  File: texinfo, Node: Other Info Files, Prev: Menu Example, Up: Menus Referring to Other Info Files ============================= You can create a menu entry that enables a reader in Info to go to a node in another Info file by writing the file name in parentheses just before the node name. In this case, you should use the three-part menu entry format, which saves the reader from having to type the file name. The format looks like this: @menu * FIRST-ENTRY-NAME:(FILENAME)NODENAME. DESCRIPTION * SECOND-ENTRY-NAME:(FILENAME)SECOND-NODE. DESCRIPTION @end menu For example, to refer directly to the `Outlining' and `Rebinding' nodes in the `Emacs Manual', you would write a menu like this: @menu * Outlining: (emacs)Outline Mode. The major mode for editing outlines. * Rebinding: (emacs)Rebinding. How to redefine the meaning of a key. @end menu If you do not list the node name, but only name the file, then Info presumes that you are referring to the `Top' node. The `dir' file that contains the main menu for Info has menu entries that list only file names. These take you directly to the `Top' nodes of each Info document. (*Note Installing an Info File::.) For example: * Info: (info). Documentation browsing system. * Emacs: (emacs). The extensible, self-documenting text editor. (The `dir' top level directory for the Info system is an Info file, not a Texinfo file, but a menu entry looks the same in both types of file.) The GNU Emacs Texinfo mode menu updating commands only work with nodes within the current buffer, so you cannot use them to create menus that refer to other files. You must write such menus by hand.  File: texinfo, Node: Cross References, Next: Marking Text, Prev: Menus, Up: Top Cross References **************** "Cross references" are used to refer the reader to other parts of the same or different Texinfo files. In Texinfo, nodes and anchors are the places to which cross references can refer. * Menu: * References:: What cross references are for. * Cross Reference Commands:: A summary of the different commands. * Cross Reference Parts:: A cross reference has several parts. * xref:: Begin a reference with `See' ... * Top Node Naming:: How to refer to the beginning of another file. * ref:: A reference for the last part of a sentence. * pxref:: How to write a parenthetical cross reference. * inforef:: How to refer to an Info-only file. * uref:: How to refer to a uniform resource locator.  File: texinfo, Node: References, Next: Cross Reference Commands, Prev: Cross References, Up: Cross References What References Are For ======================= Often, but not always, a printed document should be designed so that it can be read sequentially. People tire of flipping back and forth to find information that should be presented to them as they need it. However, in any document, some information will be too detailed for the current context, or incidental to it; use cross references to provide access to such information. Also, an online help system or a reference manual is not like a novel; few read such documents in sequence from beginning to end. Instead, people look up what they need. For this reason, such creations should contain many cross references to help readers find other information that they may not have read. In a printed manual, a cross reference results in a page reference, unless it is to another manual altogether, in which case the cross reference names that manual. In Info, a cross reference results in an entry that you can follow using the Info `f' command. (*note Some advanced Info commands: (info)Help-Adv.) The various cross reference commands use nodes (or anchors, *note `@anchor': anchor.) to define cross reference locations. This is evident in Info, in which a cross reference takes you to the specified location. TeX also uses nodes to define cross reference locations, but the action is less obvious. When TeX generates a DVI file, it records each node's page number and uses the page numbers in making references. Thus, if you are writing a manual that will only be printed, and will not be used online, you must nonetheless write `@node' lines to name the places to which you make cross references.  File: texinfo, Node: Cross Reference Commands, Next: Cross Reference Parts, Prev: References, Up: Cross References Different Cross Reference Commands ================================== There are four different cross reference commands: `@xref' Used to start a sentence in the printed manual saying `See ...' or an Info cross-reference saying `*Note NAME: NODE.'. `@ref' Used within or, more often, at the end of a sentence; same as `@xref' for Info; produces just the reference in the printed manual without a preceding `See'. `@pxref' Used within parentheses to make a reference that suits both an Info file and a printed book. Starts with a lower case `see' within the printed manual. (`p' is for `parenthesis'.) `@inforef' Used to make a reference to an Info file for which there is no printed manual. (The `@cite' command is used to make references to books and manuals for which there is no corresponding Info file and, therefore, no node to which to point. *Note `@cite': cite.)  File: texinfo, Node: Cross Reference Parts, Next: xref, Prev: Cross Reference Commands, Up: Cross References Parts of a Cross Reference ========================== A cross reference command requires only one argument, which is the name of the node to which it refers. But a cross reference command may contain up to four additional arguments. By using these arguments, you can provide a cross reference name for Info, a topic description or section title for the printed output, the name of a different Info file, and the name of a different printed manual. Here is a simple cross reference example: @xref{Node name}. which produces *Note Node name::. and See Section NNN [Node name], page PPP. Here is an example of a full five-part cross reference: @xref{Node name, Cross Reference Name, Particular Topic, info-file-name, A Printed Manual}, for details. which produces *Note Cross Reference Name: (info-file-name)Node name, for details. in Info and See section "Particular Topic" in A Printed Manual, for details. in a printed book. The five possible arguments for a cross reference are: 1. The node or anchor name (required). This is the location to which the cross reference takes you. In a printed document, the location of the node provides the page reference only for references within the same document. 2. The cross reference name for the Info reference, if it is to be different from the node name. If you include this argument, it becomes the first part of the cross reference. It is usually omitted. 3. A topic description or section name. Often, this is the title of the section. This is used as the name of the reference in the printed manual. If omitted, the node name is used. 4. The name of the Info file in which the reference is located, if it is different from the current file. You need not include any `.info' suffix on the file name, since Info readers try appending it automatically. 5. The name of a printed manual from a different Texinfo file. The template for a full five argument cross reference looks like this: @xref{NODE-NAME, CROSS-REFERENCE-NAME, TITLE-OR-TOPIC, INFO-FILE-NAME, PRINTED-MANUAL-TITLE}. Cross references with one, two, three, four, and five arguments are described separately following the description of `@xref'. Write a node name in a cross reference in exactly the same way as in the `@node' line, including the same capitalization; otherwise, the formatters may not find the reference. You can write cross reference commands within a paragraph, but note how Info and TeX format the output of each of the various commands: write `@xref' at the beginning of a sentence; write `@pxref' only within parentheses, and so on.  File: texinfo, Node: xref, Next: Top Node Naming, Prev: Cross Reference Parts, Up: Cross References `@xref' ======= The `@xref' command generates a cross reference for the beginning of a sentence. The Info formatting commands convert it into an Info cross reference, which the Info `f' command can use to bring you directly to another node. The TeX typesetting commands convert it into a page reference, or a reference to another book or manual. * Menu: * Reference Syntax:: What a reference looks like and requires. * One Argument:: `@xref' with one argument. * Two Arguments:: `@xref' with two arguments. * Three Arguments:: `@xref' with three arguments. * Four and Five Arguments:: `@xref' with four and five arguments.  File: texinfo, Node: Reference Syntax, Next: One Argument, Prev: xref, Up: xref What a Reference Looks Like and Requires ---------------------------------------- Most often, an Info cross reference looks like this: *Note NODE-NAME::. or like this *Note CROSS-REFERENCE-NAME: NODE-NAME. In TeX, a cross reference looks like this: See Section SECTION-NUMBER [NODE-NAME], page PAGE. or like this See Section SECTION-NUMBER [TITLE-OR-TOPIC], page PAGE. The `@xref' command does not generate a period or comma to end the cross reference in either the Info file or the printed output. You must write that period or comma yourself; otherwise, Info will not recognize the end of the reference. (The `@pxref' command works differently. *Note `@pxref': pxref.) *Please note:* A period or comma *must* follow the closing brace of an `@xref'. It is required to terminate the cross reference. This period or comma will appear in the output, both in the Info file and in the printed manual. `@xref' must refer to an Info node by name. Use `@node' to define the node (*note Writing a Node::). `@xref' is followed by several arguments inside braces, separated by commas. Whitespace before and after these commas is ignored. A cross reference requires only the name of a node; but it may contain up to four additional arguments. Each of these variations produces a cross reference that looks somewhat different. *Please note:* Commas separate arguments in a cross reference; avoid including them in the title or other part lest the formatters mistake them for separators.  File: texinfo, Node: One Argument, Next: Two Arguments, Prev: Reference Syntax, Up: xref `@xref' with One Argument ------------------------- The simplest form of `@xref' takes one argument, the name of another node in the same Info file. The Info formatters produce output that the Info readers can use to jump to the reference; TeX produces output that specifies the page and section number for you. For example, @xref{Tropical Storms}. produces *Note Tropical Storms::. and See Section 3.1 [Tropical Storms], page 24. (Note that in the preceding example the closing brace is followed by a period.) You can write a clause after the cross reference, like this: @xref{Tropical Storms}, for more info. which produces *Note Tropical Storms::, for more info. and See Section 3.1 [Tropical Storms], page 24, for more info. (Note that in the preceding example the closing brace is followed by a comma, and then by the clause, which is followed by a period.)  File: texinfo, Node: Two Arguments, Next: Three Arguments, Prev: One Argument, Up: xref `@xref' with Two Arguments -------------------------- With two arguments, the second is used as the name of the Info cross reference, while the first is still the name of the node to which the cross reference points. The template is like this: @xref{NODE-NAME, CROSS-REFERENCE-NAME}. For example, @xref{Electrical Effects, Lightning}. produces: *Note Lightning: Electrical Effects. and See Section 5.2 [Electrical Effects], page 57. (Note that in the preceding example the closing brace is followed by a period; and that the node name is printed, not the cross reference name.) You can write a clause after the cross reference, like this: @xref{Electrical Effects, Lightning}, for more info. which produces *Note Lightning: Electrical Effects, for more info. and See Section 5.2 [Electrical Effects], page 57, for more info. (Note that in the preceding example the closing brace is followed by a comma, and then by the clause, which is followed by a period.) t a sentence in the printed manual saying `See ...' or an Info cross-reference saying `*Note NAME: NODE.'. `@ref' Used within or, more often, at the end of a sentence; same as `@xref' for Info; produces just the reference in the printed manual without a preceding `See'. `@pxref' Used within parentheses to make a reference that suits both an Info ./info/texinfo-5 644 0 0 143300 7442531461 6705 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Three Arguments, Next: Four and Five Arguments, Prev: Two Arguments, Up: xref `@xref' with Three Arguments ---------------------------- A third argument replaces the node name in the TeX output. The third argument should be the name of the section in the printed output, or else state the topic discussed by that section. Often, you will want to use initial upper case letters so it will be easier to read when the reference is printed. Use a third argument when the node name is unsuitable because of syntax or meaning. Remember to avoid placing a comma within the title or topic section of a cross reference, or within any other section. The formatters divide cross references into arguments according to the commas; a comma within a title or other section will divide it into two arguments. In a reference, you need to write a title such as "Clouds, Mist, and Fog" without the commas. Also, remember to write a comma or period after the closing brace of an `@xref' to terminate the cross reference. In the following examples, a clause follows a terminating comma. The template is like this: @xref{NODE-NAME, CROSS-REFERENCE-NAME, TITLE-OR-TOPIC}. For example, @xref{Electrical Effects, Lightning, Thunder and Lightning}, for details. produces *Note Lightning: Electrical Effects, for details. and See Section 5.2 [Thunder and Lightning], page 57, for details. If a third argument is given and the second one is empty, then the third argument serves both. (Note how two commas, side by side, mark the empty second argument.) @xref{Electrical Effects, , Thunder and Lightning}, for details. produces *Note Thunder and Lightning: Electrical Effects, for details. and See Section 5.2 [Thunder and Lightning], page 57, for details. As a practical matter, it is often best to write cross references with just the first argument if the node name and the section title are the same, and with the first and third arguments if the node name and title are different. Here are several examples from `The GNU Awk User's Guide': @xref{Sample Program}. @xref{Glossary}. @xref{Case-sensitivity, ,Case-sensitivity in Matching}. @xref{Close Output, , Closing Output Files and Pipes}, for more information. @xref{Regexp, , Regular Expressions as Patterns}.  File: texinfo, Node: Four and Five Arguments, Prev: Three Arguments, Up: xref `@xref' with Four and Five Arguments ------------------------------------ In a cross reference, a fourth argument specifies the name of another Info file, different from the file in which the reference appears, and a fifth argument specifies its title as a printed manual. Remember that a comma or period must follow the closing brace of an `@xref' command to terminate the cross reference. In the following examples, a clause follows a terminating comma. The template is: @xref{NODE-NAME, CROSS-REFERENCE-NAME, TITLE-OR-TOPIC, INFO-FILE-NAME, PRINTED-MANUAL-TITLE}. For example, @xref{Electrical Effects, Lightning, Thunder and Lightning, weather, An Introduction to Meteorology}, for details. produces *Note Lightning: (weather)Electrical Effects, for details. The name of the Info file is enclosed in parentheses and precedes the name of the node. In a printed manual, the reference looks like this: See section "Thunder and Lightning" in An Introduction to Meteorology, for details. The title of the printed manual is typeset in italics; and the reference lacks a page number since TeX cannot know to which page a reference refers when that reference is to another manual. Often, you will leave out the second argument when you use the long version of `@xref'. In this case, the third argument, the topic description, will be used as the cross reference name in Info. The template looks like this: @xref{NODE-NAME, , TITLE-OR-TOPIC, INFO-FILE-NAME, PRINTED-MANUAL-TITLE}, for details. which produces *Note TITLE-OR-TOPIC: (INFO-FILE-NAME)NODE-NAME, for details. and See section TITLE-OR-TOPIC in PRINTED-MANUAL-TITLE, for details. For example, @xref{Electrical Effects, , Thunder and Lightning, weather, An Introduction to Meteorology}, for details. produces *Note Thunder and Lightning: (weather)Electrical Effects, for details. and See section "Thunder and Lightning" in An Introduction to Meteorology, for details. On rare occasions, you may want to refer to another Info file that is within a single printed manual--when multiple Texinfo files are incorporated into the same TeX run but make separate Info files. In this case, you need to specify only the fourth argument, and not the fifth.  File: texinfo, Node: Top Node Naming, Next: ref, Prev: xref, Up: Cross References Naming a `Top' Node =================== In a cross reference, you must always name a node. This means that in order to refer to a whole manual, you must identify the `Top' node by writing it as the first argument to the `@xref' command. (This is different from the way you write a menu entry; see *Note Referring to Other Info Files: Other Info Files.) At the same time, to provide a meaningful section topic or title in the printed cross reference (instead of the word `Top'), you must write an appropriate entry for the third argument to the `@xref' command. Thus, to make a cross reference to `The GNU Make Manual', write: @xref{Top, , Overview, make, The GNU Make Manual}. which produces *Note Overview: (make)Top. and See section "Overview" in The GNU Make Manual. In this example, `Top' is the name of the first node, and `Overview' is the name of the first section of the manual.  File: texinfo, Node: ref, Next: pxref, Prev: Top Node Naming, Up: Cross References `@ref' ====== `@ref' is nearly the same as `@xref' except that it does not generate a `See' in the printed output, just the reference itself. This makes it useful as the last part of a sentence. For example, For more information, see @ref{Hurricanes}. produces For more information, see *Note Hurricanes::. and For more information, see Section 8.2 [Hurricanes], page 123. The `@ref' command sometimes leads writers to express themselves in a manner that is suitable for a printed manual but looks awkward in the Info format. Bear in mind that your audience will be using both the printed and the Info format. For example, Sea surges are described in @ref{Hurricanes}. produces Sea surges are described in Section 6.7 [Hurricanes], page 72. in a printed document, and the following in Info: Sea surges are described in *Note Hurricanes::. *Caution:* You _must_ write a period, comma, or right parenthesis immediately after an `@ref' command with two or more arguments. Otherwise, Info will not find the end of the cross reference entry and its attempt to follow the cross reference will fail. As a general rule, you should write a period or comma after every `@ref' command. This looks best in both the printed and the Info output.  File: texinfo, Node: pxref, Next: inforef, Prev: ref, Up: Cross References `@pxref' ======== The parenthetical reference command, `@pxref', is nearly the same as `@xref', but you use it _only_ inside parentheses and you do _not_ type a comma or period after the command's closing brace. The command differs from `@xref' in two ways: 1. TeX typesets the reference for the printed manual with a lower case `see' rather than an upper case `See'. 2. The Info formatting commands automatically end the reference with a closing colon or period. Because one type of formatting automatically inserts closing punctuation and the other does not, you should use `@pxref' _only_ inside parentheses as part of another sentence. Also, you yourself should not insert punctuation after the reference, as you do with `@xref'. `@pxref' is designed so that the output looks right and works right between parentheses both in printed output and in an Info file. In a printed manual, a closing comma or period should not follow a cross reference within parentheses; such punctuation is wrong. But in an Info file, suitable closing punctuation must follow the cross reference so Info can recognize its end. `@pxref' spares you the need to use complicated methods to put a terminator into one form of the output and not the other. With one argument, a parenthetical cross reference looks like this: ... storms cause flooding (@pxref{Hurricanes}) ... which produces ... storms cause flooding (*Note Hurricanes::) ... and ... storms cause flooding (see Section 6.7 [Hurricanes], page 72) ... With two arguments, a parenthetical cross reference has this template: ... (@pxref{NODE-NAME, CROSS-REFERENCE-NAME}) ... which produces ... (*Note CROSS-REFERENCE-NAME: NODE-NAME.) ... and ... (see Section NNN [NODE-NAME], page PPP) ... `@pxref' can be used with up to five arguments just like `@xref' (*note `@xref': xref.). *Please note:* Use `@pxref' only as a parenthetical reference. Do not try to use `@pxref' as a clause in a sentence. It will look bad in either the Info file, the printed output, or both. Also, parenthetical cross references look best at the ends of sentences. Although you may write them in the middle of a sentence, that location breaks up the flow of text.  File: texinfo, Node: inforef, Next: uref, Prev: pxref, Up: Cross References `@inforef' ========== `@inforef' is used for cross references to Info files for which there are no printed manuals. Even in a printed manual, `@inforef' generates a reference directing the user to look in an Info file. The command takes either two or three arguments, in the following order: 1. The node name. 2. The cross reference name (optional). 3. The Info file name. Separate the arguments with commas, as with `@xref'. Also, you must terminate the reference with a comma or period after the `}', as you do with `@xref'. The template is: @inforef{NODE-NAME, CROSS-REFERENCE-NAME, INFO-FILE-NAME}, Thus, @inforef{Expert, Advanced Info commands, info}, for more information. produces *Note Advanced Info commands: (info)Expert, for more information. and See Info file `info', node `Expert', for more information. Similarly, @inforef{Expert, , info}, for more information. produces *Note (info)Expert::, for more information. and See Info file `info', node `Expert', for more information. The converse of `@inforef' is `@cite', which is used to refer to printed works for which no Info form exists. *Note `@cite': cite.  File: texinfo, Node: uref, Prev: inforef, Up: Cross References `@uref{URL[, TEXT][, REPLACEMENT]}' =================================== `@uref' produces a reference to a uniform resource locator (url). It takes one mandatory argument, the url, and two optional arguments which control the text that is displayed. In HTML output, `@uref' produces a link you can follow. The second argument, if specified, is the text to display (the default is the url itself); in Info and DVI output, but not in HTML output, the url is also output. The third argument, on the other hand, if specified is also the text to display, but the url is _not_ output in any format. This is useful when the text is already sufficiently referential, as in a man page. If the third argument is given, the second argument is ignored. The simple one argument form, where the url is both the target and the text of the link: The official GNU ftp site is @uref{ftp://ftp.gnu.org/gnu}. produces: The official GNU ftp site is `ftp://ftp.gnu.org/gnu'. An example of the two-argument form: The official @uref{ftp://ftp.gnu.org/gnu, GNU ftp site} holds programs and texts. produces: The official GNU ftp site (ftp://ftp.gnu.org/gnu) holds programs and texts. that is, the Info output is this: The official GNU ftp site (ftp://ftp.gnu.org/gnu) holds programs and texts. and the HTML output is this: The official GNU ftp site holds programs and texts. An example of the three-argument form: The @uref{/man.cgi/1/ls,,ls(1)} program ... produces: The ls(1) program ... but with HTML: The ls(1) program ... To merely indicate a url without creating a link people can follow, use `@url' (*note `@url': url.). Some people prefer to display url's in the unambiguous format: You can use this form in the input file if you wish. We feel it's not necessary to clutter up the output with the extra `', since any software that tries to detect url's in text already has to detect them without the ` key": @kbd{r @key{RET}} This produces: `r ' You also use the `@kbd' command if you are spelling out the letters you type; for example: To give the @code{logout} command, type the characters @kbd{l o g o u t @key{RET}}. This produces: To give the `logout' command, type the characters `l o g o u t '. (Also, this example shows that you can add spaces for clarity. If you really want to mention a space character as one of the characters of input, write `@key{SPC}' for it.)  File: texinfo, Node: key, Next: samp, Prev: kbd, Up: Indicating `@key'{KEY-NAME} ---------------- Use the `@key' command for the conventional name for a key on a keyboard, as in: @key{RET} You can use the `@key' command within the argument of an `@kbd' command when the sequence of characters to be typed includes one or more keys that are described by name. For example, to produce `C-x ' you would type: @kbd{C-x @key{ESC}} Here is a list of the recommended names for keys: SPC Space RET Return LFD Linefeed (however, since most keyboards nowadays do not have a Linefeed key, it might be better to call this character `C-j'. TAB Tab BS Backspace ESC Escape DEL Delete SHIFT Shift CTRL Control META Meta There are subtleties to handling words like `meta' or `ctrl' that are names of modifier keys. When mentioning a character in which the modifier key is used, such as `Meta-a', use the `@kbd' command alone; do not use the `@key' command; but when you are referring to the modifier key in isolation, use the `@key' command. For example, write `@kbd{Meta-a}' to produce `Meta-a' and `@key{META}' to produce .  File: texinfo, Node: samp, Next: verb, Prev: key, Up: Indicating `@samp'{TEXT} ------------- Use the `@samp' command to indicate text that is a literal example or `sample' of a sequence of characters in a file, string, pattern, etc. Enclose the text in braces. The argument appears within single quotation marks in both the Info file and the printed manual; in addition, it is printed in a fixed-width font. To match @samp{foo} at the end of the line, use the regexp @samp{foo$}. produces To match `foo' at the end of the line, use the regexp `foo$'. Any time you are referring to single characters, you should use `@samp' unless `@kbd' or `@key' is more appropriate. Also, you may use `@samp' for entire statements in C and for entire shell commands--in this case, `@samp' often looks better than `@code'. Basically, `@samp' is a catchall for whatever is not covered by `@code', `@kbd', or `@key'. Only include punctuation marks within braces if they are part of the string you are specifying. Write punctuation marks outside the braces if those punctuation marks are part of the English text that surrounds the string. In the following sentence, for example, the commas and period are outside of the braces: In English, the vowels are @samp{a}, @samp{e}, @samp{i}, @samp{o}, @samp{u}, and sometimes @samp{y}. This produces: In English, the vowels are `a', `e', `i', `o', `u', and sometimes `y'.  File: texinfo, Node: verb, Next: var, Prev: samp, Up: Indicating `@verb'{TEXT} ------------------------- Use the `@verb' command to print a verbatim sequence of characters. Like LaTeX's `\verb' command, the verbatim text can be quoted using any unique delimiter character. Enclose the verbatim text, including the delimiters, in braces. Text is printed in a fixed-width font: How many @verb{|@|}-escapes does one need to print this @verb{.@a @b @c.} string or @verb{+@'e?`!`{}\+} this? produces How many @-escapes does one need to print this @a @b @c string or these @'e?`{}!`\ this? This is in contrast to `@samp' (see the previous section), whose argument is normal Texinfo text, where the characters `@{}' are special; with `@verb', nothing is special except the delimiter character you choose.  File: texinfo, Node: var, Next: env, Prev: verb, Up: Indicating `@var'{METASYNTACTIC-VARIABLE} ------------------------------ Use the `@var' command to indicate metasyntactic variables. A "metasyntactic variable" is something that stands for another piece of text. For example, you should use a metasyntactic variable in the documentation of a function to describe the arguments that are passed to that function. Do not use `@var' for the names of particular variables in programming languages. These are specific names from a program, so `@code' is correct for them (*note code::). For example, the Emacs Lisp variable `texinfo-tex-command' is not a metasyntactic variable; it is properly formatted using `@code'. Do not use `@var' for environment variables either; `@env' is correct for them (see the next section). The effect of `@var' in the Info file is to change the case of the argument to all upper case. In the printed manual and HTML output, the argument is printed in slanted type. For example, To delete file @var{filename}, type @samp{rm @var{filename}}. produces To delete file FILENAME, type `rm FILENAME'. (Note that `@var' may appear inside `@code', `@samp', `@file', etc.) Write a metasyntactic variable all in lower case without spaces, and use hyphens to make it more readable. Thus, the Texinfo source for the illustration of how to begin a Texinfo manual looks like this: \input texinfo @@setfilename @var{info-file-name} @@settitle @var{name-of-manual} This produces: \input texinfo @setfilename INFO-FILE-NAME @settitle NAME-OF-MANUAL In some documentation styles, metasyntactic variables are shown with angle brackets, for example: ..., type rm However, that is not the style that Texinfo uses. (You can, of course, modify the sources to `texinfo.tex' and the Info formatting commands to output the `<...>' format if you wish.)  File: texinfo, Node: env, Next: file, Prev: var, Up: Indicating `@env'{ENVIRONMENT-VARIABLE} ---------------------------- Use the `@env' command to indicate environment variables, as used by many operating systems, including GNU. Do not use it for metasyntactic variables; use `@var' instead (see the previous section). `@env' is equivalent to `@code' in its effects. For example: The @env{PATH} environment variable ... produces The `PATH' environment variable ...  File: texinfo, Node: file, Next: command, Prev: env, Up: Indicating `@file'{FILE-NAME} ------------------ Use the `@file' command to indicate text that is the name of a file, buffer, or directory, or is the name of a node in Info. You can also use the command for file name suffixes. Do not use `@file' for symbols in a programming language; use `@code'. Currently, `@file' is equivalent to `@samp' in its effects. For example, The @file{.el} files are in the @file{/usr/local/emacs/lisp} directory. produces The `.el' files are in the `/usr/local/emacs/lisp' directory.  File: texinfo, Node: command, Next: option, Prev: file, Up: Indicating `@command'{COMMAND-NAME} ------------------------ Use the `@command' command to indicate command names, such as `ls' or `cc'. `@command' is equivalent to `@code' in its effects. For example: The command @command{ls} lists directory contents. produces The command `ls' lists directory contents. You should write the name of a program in the ordinary text font, rather than using `@command', if you regard it as a new English word, such as `Emacs' or `Bison'. When writing an entire shell command invocation, as in `ls -l', you should use either `@samp' or `@code' at your discretion.  File: texinfo, Node: option, Next: dfn, Prev: command, Up: Indicating `@option'{OPTION-NAME} ---------------------- Use the `@option' command to indicate a command-line option; for example, `-l' or `--version' or `--output=FILENAME'. `@option' is equivalent to `@samp' in its effects. For example: The option @option{-l} produces a long listing. produces The option `-l' produces a long listing. In tables, putting options inside `@code' produces a more pleasing effect.  File: texinfo, Node: dfn, Next: cite, Prev: option, Up: Indicating `@dfn'{TERM} ------------ Use the `@dfn' command to identify the introductory or defining use of a technical term. Use the command only in passages whose purpose is to introduce a term which will be used again or which the reader ought to know. Mere passing mention of a term for the first time does not deserve `@dfn'. The command generates italics in the printed manual, and double quotation marks in the Info file. For example: Getting rid of a file is called @dfn{deleting} it. produces Getting rid of a file is called "deleting" it. As a general rule, a sentence containing the defining occurrence of a term should be a definition of the term. The sentence does not need to say explicitly that it is a definition, but it should contain the information of a definition--it should make the meaning clear.  File: texinfo, Node: cite, Next: acronym, Prev: dfn, Up: Indicating `@cite'{REFERENCE} ------------------ Use the `@cite' command for the name of a book that lacks a companion Info file. The command produces italics in the printed manual, and quotation marks in the Info file. If a book is written in Texinfo, it is better to use a cross reference command since a reader can easily follow such a reference in Info. *Note `@xref': xref.  File: texinfo, Node: acronym, Next: url, Prev: cite, Up: Indicating `@acronym'{ACRONYM} ------------------- Use the `@acronym' command for abbreviations written in all capital letters, such as `NASA'. The abbreviation is given as the single argument in braces, as in `@acronym{NASA}'. As a matter of style, or for particular abbreviations, you may prefer to use periods, as in `@acronym{F.B.I.}'. In TeX and HTML, the argument is printed in a slightly smaller font size. In Info or plain text output, this command changes nothing.  File: texinfo, Node: url, Next: email, Prev: acronym, Up: Indicating `@url'{UNIFORM-RESOURCE-LOCATOR} -------------------------------- Use the `@url' command to indicate a uniform resource locator on the World Wide Web. This is analogous to `@file', `@var', etc., and is purely for markup purposes. It does not produce a link you can follow in HTML output (use the `@uref' command for that, *note `@uref': uref.). It is useful for url's which do not actually exist. For example: For example, the url might be @url{http://example.org/path}. which produces: For example, the url might be .  File: texinfo, Node: email, Prev: url, Up: Indicating `@email'{EMAIL-ADDRESS[, DISPLAYED-TEXT]} ----------------------------------------- Use the `@email' command to indicate an electronic mail address. It takes one mandatory argument, the address, and one optional argument, the text to display (the default is the address itself). In Info and TeX, the address is shown in angle brackets, preceded by the text to display if any. In HTML output, `@email' produces a `mailto' link that usually brings up a mail composition window. For example: Send bug reports to @email{bug-texinfo@@gnu.org}, suggestions to the @email{bug-texinfo@@gnu.org, same place}. produces Send bug reports to , suggestions to the same place .  File: texinfo, Node: Emphasis, Prev: Indicating, Up: Marking Text Emphasizing Text ================ Usually, Texinfo changes the font to mark words in the text according to what category the words belong to; an example is the `@code' command. Most often, this is the best way to mark words. However, sometimes you will want to emphasize text without indicating a category. Texinfo has two commands to do this. Also, Texinfo has several commands that specify the font in which TeX will typeset text. These commands have no effect on Info and only one of them, the `@r' command, has any regular use. * Menu: * emph & strong:: How to emphasize text in Texinfo. * Smallcaps:: How to use the small caps font. * Fonts:: Various font commands for printed output.  File: texinfo, Node: emph & strong, Next: Smallcaps, Up: Emphasis `@emph'{TEXT} and `@strong'{TEXT} --------------------------------- The `@emph' and `@strong' commands are for emphasis; `@strong' is stronger. In printed output, `@emph' produces _italics_ and `@strong' produces *bold*. For example, @quotation @strong{Caution:} @samp{rm * .[^.]*} removes @emph{all} files in the directory. @end quotation produces: *Caution*: `rm * .[^.]*' removes _all_ files in the directory. The `@strong' command is seldom used except to mark what is, in effect, a typographical element, such as the word `Caution' in the preceding example. In the Info output, `@emph' surrounds the text with underscores (`_'), and `@strong' puts asterisks around the text. *Caution:* Do not use `@strong' with the word `Note'; Info will mistake the combination for a cross reference. Use a phrase such as *Please note* or *Caution* instead.  File: texinfo, Node: Smallcaps, Next: Fonts, Prev: emph & strong, Up: Emphasis `@sc'{TEXT}: The Small Caps Font -------------------------------- Use the `@sc' command to set text in the printed and the HTML output in A SMALL CAPS FONT and set text in the Info file in upper case letters. Write the text you want to be in small caps (where possible) between braces in lower case, like this: The @sc{acm} and @sc{ieee} are technical societies. This produces: The ACM and IEEE are technical societies. TeX typesets the small caps font in a manner that prevents the letters from `jumping out at you on the page'. This makes small caps text easier to read than text in all upper case--but it's usually better to use regular mixed case anyway. The Info formatting commands set all small caps text in upper case. In HTML, the text is upper-cased and a smaller font is used to render it. If the text between the braces of an `@sc' command is uppercase, TeX typesets in FULL-SIZE CAPITALS. Use full-size capitals sparingly, if ever, and since it's redundant to mark all-uppercase text with `@sc', `makeinfo' warns about such usage. You may also use the small caps font for a jargon word such as ATO (a NASA word meaning `abort to orbit'). There are subtleties to using the small caps font with a jargon word such as CDR, a word used in Lisp programming. In this case, you should use the small caps font when the word refers to the second and subsequent elements of a list (the CDR of the list), but you should use `@code' when the word refers to the Lisp function of the same spelling.  File: texinfo, Node: Fonts, Prev: Smallcaps, Up: Emphasis Fonts for Printing, Not Info ---------------------------- Texinfo provides four font commands that specify font changes in the printed manual but have no effect in the Info file. `@i' requests italic font (in some versions of TeX, a slanted font is used), `@b' requests bold face, `@t' requests the fixed-width, typewriter-style font used by `@code', and `@r' requests a roman font, which is the usual font in which text is printed. All four commands apply to an argument that follows, surrounded by braces. Only the `@r' command has much use: in example programs, you can use the `@r' command to convert code comments from the fixed-width font to a roman font. This looks better in printed output. For example, @lisp (+ 2 2) ; @r{Add two plus two.} @end lisp produces (+ 2 2) ; Add two plus two. If possible, you should avoid using the other three font commands. If you need to use one, it probably indicates a gap in the Texinfo language.  File: texinfo, Node: Quotations and Examples, Next: Lists and Tables, Prev: Marking Text, Up: Top Quotations and Examples *********************** Quotations and examples are blocks of text consisting of one or more whole paragraphs that are set off from the bulk of the text and treated differently. They are usually indented. In Texinfo, you always begin a quotation or example by writing an @-command at the beginning of a line by itself, and end it by writing an `@end' command that is also at the beginning of a line by itself. For instance, you begin an example by writing `@example' by itself at the beginning of a line and end the example by writing `@end example' on a line by itself, at the beginning of that line. * Menu: * Block Enclosing Commands:: Different constructs for different purposes. * quotation:: Writing a quotation. * example:: Writing an example in a fixed-width font. * verbatim:: Writing a verbatim example. * verbatiminclude:: Including a file verbatim. * lisp:: Illustrating Lisp code. * small:: Forms for `@smallbook'. * display:: Writing an example in the current font. * format:: Writing an example without narrowed margins. * exdent:: Undo indentation on a line. * flushleft & flushright:: Pushing text flush left or flush right. * noindent:: Preventing paragraph indentation. * cartouche:: Drawing rounded rectangles around examples.  File: texinfo, Node: Block Enclosing Commands, Next: quotation, Up: Quotations and Examples Block Enclosing Commands ======================== Here are commands for quotations and examples, explained further in the following sections: `@quotation' Indicate text that is quoted. The text is filled, indented, and printed in a roman font by default. `@example' Illustrate code, commands, and the like. The text is printed in a fixed-width font, and indented but not filled. `@verbatim' Mark a piece of text that is to be printed verbatim; no character substitutions are made and all commands are ignored, until the next `@end verbatim'. The text is printed in a fixed-width font, and not indented or filled. Extra spaces and blank lines are significant, and tabs are expanded. `@smallexample' Same as `@example', except that in TeX this command typesets text in a smaller font. `@lisp' Like `@example', but specifically for illustrating Lisp code. The text is printed in a fixed-width font, and indented but not filled. `@smalllisp' Is to `@lisp' as `@smallexample' is to `@example'. `@display' Display illustrative text. The text is indented but not filled, and no font is selected (so, by default, the font is roman). `@smalldisplay' Is to `@display' as `@smallexample' is to `@example'. `@format' Like `@display' (the text is not filled and no font is selected), but the text is not indented. `@smallformat' Is to `@format' as `@smallexample' is to `@example'. The `@exdent' command is used within the above constructs to undo the indentation of a line. The `@flushleft' and `@flushright' commands are used to line up the left or right margins of unfilled text. The `@noindent' command may be used after one of the above constructs to prevent the following text from being indented as a new paragraph. You can use the `@cartouche' command within one of the above constructs to highlight the example or quotation by drawing a box with rounded corners around it. *Note Drawing Cartouches Around Examples: cartouche.  File: texinfo, Node: quotation, Next: example, Prev: Block Enclosing Commands, Up: Quotations and Examples `@quotation' ============ The text of a quotation is processed normally except that: * the margins are closer to the center of the page, so the whole of the quotation is indented; * the first lines of paragraphs are indented no more than other lines; * in the printed output, interparagraph spacing is reduced. This is an example of text written between an `@quotation' command and an `@end quotation' command. An `@quotation' command is most often used to indicate text that is excerpted from another (real or hypothetical) printed work. Write an `@quotation' command as text on a line by itself. This line will disappear from the output. Mark the end of the quotation with a line beginning with and containing only `@end quotation'. The `@end quotation' line will likewise disappear from the output. Thus, the following, @quotation This is a foo. @end quotation produces This is a foo.  File: texinfo, Node: example, Next: verbatim, Prev: quotation, Up: Quotations and Examples `@example': Example Text ======================== The `@example' command is used to indicate an example that is not part of the running text, such as computer input or output. This is an example of text written between an `@example' command and an `@end example' command. The text is indented but not filled. In the printed manual, the text is typeset in a fixed-width font, and extra spaces and blank lines are significant. In the Info file, an analogous result is obtained by indenting each line with five spaces. Write an `@example' command at the beginning of a line by itself. Mark the end of the example with an `@end example' command, also written at the beginning of a line by itself. For example, @example mv foo bar @end example produces mv foo bar The lines containing `@example' and `@end example' will disappear from the output. To make the output look good, you should put a blank line before the `@example' and another blank line after the `@end example'. Note that blank lines inside the beginning `@example' and the ending `@end example' will appear in the output. *Caution:* Do not use tabs in the lines of an example or anywhere else in Texinfo (except in verbatim environments)! The TeX implementation of Texinfo treats tabs as single spaces, and that is not what they look like. (If necessary, in Emacs, you can use `M-x untabify' to convert tabs in a region to multiple spaces.) Examples are often, logically speaking, "in the middle" of a paragraph, and the text that continues after an example should not be indented. The `@noindent' command prevents a piece of text from being indented as if it were a new paragraph. (*Note noindent::.) (The `@code' command is used for examples of code that are embedded within sentences, not set off from preceding and following text. *Note `@code': code.)  File: texinfo, Node: verbatim, Next: verbatiminclude, Prev: example, Up: Quotations and Examples `@verbatim': Literal Text ========================= Use the `@verbatim' environment for printing of text that may contain special characters or commands that should not be interpreted, such as computer input or output (`@example' interprets its text as regular Texinfo commands). This is especially useful for including automatically generated output in a Texinfo manual. Here is an example; the output you see is just the same as the input, with a line `@verbatim' before and a line `@end verbatim' after. This is an example of text written in a @verbatim block. No character substitutions are made all commands are ignored, until the next 'end verbatim' command. In the printed manual, the text is typeset in a fixed-width font, and not indented or filled. All spaces and blank lines are significant, including tabs. Write a `@verbatim' command at the beginning of a line by itself. This line will disappear from the output. Mark the end of the verbatim block with a `@end verbatim' command, also written at the beginning of a line by itself. The `@end verbatim' will also disappear from the output. For example: @verbatim { @command with strange characters: @'e expandme } @end verbatim produces { @command with strange characters: @'e expand me } Since the lines containing `@verbatim' and `@end verbatim' will disappear, tyically you should put a blank line before the `@verbatim' and another blank line after the `@end verbatim'. Blank lines between the beginning `@verbatim' and the ending `@end verbatim' will appear in the output.)  File: texinfo, Node: verbatiminclude, Next: lisp, Prev: verbatim, Up: Quotations and Examples `@verbatiminclude' FILE: Include a File Verbatim ================================================ You can include the exact contents of a file in the document with the `@verbatiminclude' command: @verbatiminclude FILENAME The contents of FILENAME is printed in a verbatim environment (*note `@verbatim': verbatim.). Generally, the file is printed exactly as it is, with all special characters and white space retained.  File: texinfo, Node: lisp, Next: small, Prev: verbatiminclude, Up: Quotations and Examples `@lisp': Marking a Lisp Example =============================== The `@lisp' command is used for Lisp code. It is synonymous with the `@example' command. This is an example of text written between an `@lisp' command and an `@end lisp' command. Use `@lisp' instead of `@example' to preserve information regarding the nature of the example. This is useful, for example, if you write a function that evaluates only and all the Lisp code in a Texinfo file. Then you can use the Texinfo file as a Lisp library.(1) (*note lisp-Footnote-1::) Mark the end of `@lisp' with `@end lisp' on a line by itself.  File: texinfo, Node: lisp-Footnotes, Up: lisp (1) It would be straightforward to extend Texinfo to work in a similar fashion for C, Fortran, or other languages.  File: texinfo, Node: small, Next: display, Prev: lisp, Up: Quotations and Examples `@small...' Block Commands ========================== In addition to the regular `@example' and `@lisp' commands, Texinfo has "small" example-style commands. These are `@smalldisplay', `@smallexample', `@smallformat', and `@smalllisp'. In TeX, the `@small...' commands typeset text in a smaller font than the non-small example commands. Consequently, many examples containing long lines fit on a page without needing to be shortened. In Info, the `@small...' commands are equivalent to their non-small companion commands. Mark the end of an `@small...' block with a corresponding `@end small...'. For example, pair `@smallexample' with `@end smallexample'. This is an example of text written between `@smallexample' and `@end smallexample'. In Info this text appears in its normal size; but in a 7 by 9.25 inch manual, this text appears in a smaller font. The `@small...' commands make it easier to prepare manuals without forcing you to edit examples by hand to fit them onto narrower pages. As a general rule, a printed document looks better if you use only one of (for example) `@example' or in `@smallexample' consistently within a chapter. Only occasionally should you mix the two formats. *Note Printing "Small" Books: smallbook, for more information about the `@smallbook' command. is used within the above constructs to undo the indentation of a line. The `@flushleft' and `@flushright' commands are used to line up the left or right margins of unfilled text. The `@noindent' command may be used after one of the above constructs to prevent the following text from being indented as a new parag./info/texinfo-6 644 0 0 142633 7442531461 6716 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: display, Next: format, Prev: small, Up: Quotations and Examples `@display' and `@smalldisplay' ============================== The `@display' command begins a kind of example. It is like the `@example' command except that, in a printed manual, `@display' does not select the fixed-width font. In fact, it does not specify the font at all, so that the text appears in the same font it would have appeared in without the `@display' command. This is an example of text written between an `@display' command and an `@end display' command. The `@display' command indents the text, but does not fill it. Texinfo also provides a command `@smalldisplay', which is like `@display' but uses a smaller font in `@smallbook' format. *Note small::.  File: texinfo, Node: format, Next: exdent, Prev: display, Up: Quotations and Examples `@format' and `@smallformat' ============================ The `@format' command is similar to `@example' except that, in the printed manual, `@format' does not select the fixed-width font and does not narrow the margins. This is an example of text written between an `@format' command and an `@end format' command. As you can see from this example, the `@format' command does not fill the text. Texinfo also provides a command `@smallformat', which is like `@format' but uses a smaller font in `@smallbook' format. *Note small::.  File: texinfo, Node: exdent, Next: flushleft & flushright, Prev: format, Up: Quotations and Examples `@exdent': Undoing a Line's Indentation ======================================= The `@exdent' command removes any indentation a line might have. The command is written at the beginning of a line and applies only to the text that follows the command that is on the same line. Do not use braces around the text. In a printed manual, the text on an `@exdent' line is printed in the roman font. `@exdent' is usually used within examples. Thus, @example This line follows an @@example command. @exdent This line is exdented. This line follows the exdented line. The @@end example comes on the next line. @end group produces This line follows an @example command. This line is exdented. This line follows the exdented line. The @end example comes on the next line. In practice, the `@exdent' command is rarely used. Usually, you un-indent text by ending the example and returning the page to its normal width.  File: texinfo, Node: flushleft & flushright, Next: noindent, Prev: exdent, Up: Quotations and Examples `@flushleft' and `@flushright' ============================== The `@flushleft' and `@flushright' commands line up the ends of lines on the left and right margins of a page, but do not fill the text. The commands are written on lines of their own, without braces. The `@flushleft' and `@flushright' commands are ended by `@end flushleft' and `@end flushright' commands on lines of their own. For example, @flushleft This text is written flushleft. @end flushleft produces This text is written flushleft. `@flushright' produces the type of indentation often used in the return address of letters. For example, @flushright Here is an example of text written flushright. The @code{@flushright} command right justifies every line but leaves the left end ragged. @end flushright produces Here is an example of text written flushright. The `@flushright' command right justifies every line but leaves the left end ragged.  File: texinfo, Node: noindent, Next: cartouche, Prev: flushleft & flushright, Up: Quotations and Examples `@noindent': Omitting Indentation ================================= An example or other inclusion can break a paragraph into segments. Ordinarily, the formatters indent text that follows an example as a new paragraph. However, you can prevent this by writing `@noindent' at the beginning of a line by itself preceding the continuation text. For example: @example This is an example @end example @noindent This line is not indented. As you can see, the beginning of the line is fully flush left with the line that follows after it. (This whole example is between @code{@@display} and @code{@@end display}.) produces This is an example This line is not indented. As you can see, the beginning of the line is fully flush left with the line that follows after it. (This whole example is between `@display' and `@end display'.) To adjust the number of blank lines properly in the Info file output, remember that the line containing `@noindent' does not generate a blank line, and neither does the `@end example' line. In the Texinfo source file for this manual, each line that says `produces' is preceded by a line containing `@noindent'. Do not put braces after an `@noindent' command; they are not necessary, since `@noindent' is a command used outside of paragraphs (*note Command Syntax::).  File: texinfo, Node: cartouche, Prev: noindent, Up: Quotations and Examples `@cartouche': Rounded Rectangles Around Examples ================================================ In a printed manual, the `@cartouche' command draws a box with rounded corners around its contents. You can use this command to further highlight an example or quotation. For instance, you could write a manual in which one type of example is surrounded by a cartouche for emphasis. `@cartouche' affects only the printed manual; it has no effect in other output files. For example, @example @cartouche % pwd /usr/local/share/emacs @end cartouche @end example surrounds the two-line example with a box with rounded corners, in the printed manual.  File: texinfo, Node: Lists and Tables, Next: Indices, Prev: Quotations and Examples, Up: Top Lists and Tables **************** Texinfo has several ways of making lists and tables. Lists can be bulleted or numbered; two-column tables can highlight the items in the first column; multi-column tables are also supported. * Menu: * Introducing Lists:: Texinfo formats lists for you. * itemize:: How to construct a simple list. * enumerate:: How to construct a numbered list. * Two-column Tables:: How to construct a two-column table. * Multi-column Tables:: How to construct generalized tables.  File: texinfo, Node: Introducing Lists, Next: itemize, Prev: Lists and Tables, Up: Lists and Tables Introducing Lists ================= Texinfo automatically indents the text in lists or tables, and numbers an enumerated list. This last feature is useful if you modify the list, since you do not need to renumber it yourself. Numbered lists and tables begin with the appropriate @-command at the beginning of a line, and end with the corresponding `@end' command on a line by itself. The table and itemized-list commands also require that you write formatting information on the same line as the beginning @-command. Begin an enumerated list, for example, with an `@enumerate' command and end the list with an `@end enumerate' command. Begin an itemized list with an `@itemize' command, followed on the same line by a formatting command such as `@bullet', and end the list with an `@end itemize' command. Precede each element of a list with an `@item' or `@itemx' command. Here is an itemized list of the different kinds of table and lists: * Itemized lists with and without bullets. * Enumerated lists, using numbers or letters. * Two-column tables with highlighting. Here is an enumerated list with the same items: 1. Itemized lists with and without bullets. 2. Enumerated lists, using numbers or letters. 3. Two-column tables with highlighting. And here is a two-column table with the same items and their @-commands: `@itemize' Itemized lists with and without bullets. `@enumerate' Enumerated lists, using numbers or letters. `@table' `@ftable' `@vtable' Two-column tables, optionally with indexing.  File: texinfo, Node: itemize, Next: enumerate, Prev: Introducing Lists, Up: Lists and Tables `@itemize': Making an Itemized List =================================== The `@itemize' command produces sequences of indented paragraphs, with a bullet or other mark inside the left margin at the beginning of each paragraph for which such a mark is desired. Begin an itemized list by writing `@itemize' at the beginning of a line. Follow the command, on the same line, with a character or a Texinfo command that generates a mark. Usually, you will write `@bullet' after `@itemize', but you can use `@minus', or any command or character that results in a single character in the Info file. If you don't want any mark at all, use `@w'. (When you write the mark command such as `@bullet' after an `@itemize' command, you may omit the `{}'.) If you don't specify a mark command, the default is `@bullet'. Write the text of the indented paragraphs themselves after the `@itemize', up to another line that says `@end itemize'. Before each paragraph for which a mark in the margin is desired, write a line that says just `@item'. It is ok to have text following the `@item'. Usually, you should put a blank line before an `@item'. This puts a blank line in the Info file. (TeX inserts the proper interline whitespace in either case.) Except when the entries are very brief, these blank lines make the list look better. Here is an example of the use of `@itemize', followed by the output it produces. `@bullet' produces an `*' in Info and a round dot in TeX. @itemize @bullet @item Some text for foo. @item Some text for bar. @end itemize This produces: * Some text for foo. * Some text for bar. Itemized lists may be embedded within other itemized lists. Here is a list marked with dashes embedded in a list marked with bullets: @itemize @bullet @item First item. @itemize @minus @item Inner item. @item Second inner item. @end itemize @item Second outer item. @end itemize This produces: * First item. - Inner item. - Second inner item. * Second outer item.  File: texinfo, Node: enumerate, Next: Two-column Tables, Prev: itemize, Up: Lists and Tables `@enumerate': Making a Numbered or Lettered List ================================================ `@enumerate' is like `@itemize' (*note `@itemize': itemize.), except that the labels on the items are successive integers or letters instead of bullets. Write the `@enumerate' command at the beginning of a line. The command does not require an argument, but accepts either a number or a letter as an option. Without an argument, `@enumerate' starts the list with the number `1'. With a numeric argument, such as `3', the command starts the list with that number. With an upper or lower case letter, such as `a' or `A', the command starts the list with that letter. Write the text of the enumerated list in the same way you write an itemized list: put `@item' on a line of its own before the start of each paragraph that you want enumerated. Do not write any other text on the line beginning with `@item'. You should put a blank line between entries in the list. This generally makes it easier to read the Info file. Here is an example of `@enumerate' without an argument: @enumerate @item Underlying causes. @item Proximate causes. @end enumerate This produces: 1. Underlying causes. 2. Proximate causes. Here is an example with an argument of `3': @enumerate 3 @item Predisposing causes. @item Precipitating causes. @item Perpetuating causes. @end enumerate This produces: 3. Predisposing causes. 4. Precipitating causes. 5. Perpetuating causes. Here is a brief summary of the alternatives. The summary is constructed using `@enumerate' with an argument of `a'. a. `@enumerate' Without an argument, produce a numbered list, starting with the number 1. b. `@enumerate POSITIVE-INTEGER' With a (positive) numeric argument, start a numbered list with that number. You can use this to continue a list that you interrupted with other text. c. `@enumerate UPPER-CASE-LETTER' With an upper case letter as argument, start a list in which each item is marked by a letter, beginning with that upper case letter. d. `@enumerate LOWER-CASE-LETTER' With a lower case letter as argument, start a list in which each item is marked by a letter, beginning with that lower case letter. You can also nest enumerated lists, as in an outline.  File: texinfo, Node: Two-column Tables, Next: Multi-column Tables, Prev: enumerate, Up: Lists and Tables Making a Two-column Table ========================= `@table' is similar to `@itemize' (*note `@itemize': itemize.), but allows you to specify a name or heading line for each item. The `@table' command is used to produce two-column tables, and is especially useful for glossaries, explanatory exhibits, and command-line option summaries. * Menu: * table:: How to construct a two-column table. * ftable vtable:: Automatic indexing for two-column tables. * itemx:: How to put more entries in the first column.  File: texinfo, Node: table, Next: ftable vtable, Prev: Two-column Tables, Up: Two-column Tables Using the `@table' Command -------------------------- Use the `@table' command to produce two-column tables. Write the `@table' command at the beginning of a line and follow it on the same line with an argument that is a Texinfo "indicating" command such as `@code', `@samp', `@var', or `@kbd' (*note Indicating::). Although these commands are usually followed by arguments in braces, in this case you use the command name without an argument because `@item' will supply the argument. This command will be applied to the text that goes into the first column of each item and determines how it will be highlighted. For example, `@code' will cause the text in the first column to be highlighted with an `@code' command. (We recommend `@code' for `@table''s of command-line options.) You may also choose to use the `@asis' command as an argument to `@table'. `@asis' is a command that does nothing; if you use this command after `@table', TeX and the Info formatting commands output the first column entries without added highlighting ("as is"). (The `@table' command may work with other commands besides those listed here. However, you can only use commands that normally take arguments in braces.) Begin each table entry with an `@item' command at the beginning of a line. Write the first column text on the same line as the `@item' command. Write the second column text on the line following the `@item' line and on subsequent lines. (You do not need to type anything for an empty second column entry.) You may write as many lines of supporting text as you wish, even several paragraphs. But only text on the same line as the `@item' will be placed in the first column, including any footnote. Normally, you should put a blank line before an `@item' line. This puts a blank like in the Info file. Except when the entries are very brief, a blank line looks better. The following table, for example, highlights the text in the first column with an `@samp' command: @table @samp @item foo This is the text for @samp{foo}. @item bar Text for @samp{bar}. @end table This produces: `foo' This is the text for `foo'. `bar' Text for `bar'. If you want to list two or more named items with a single block of text, use the `@itemx' command. (*Note `@itemx': itemx.)  File: texinfo, Node: ftable vtable, Next: itemx, Prev: table, Up: Two-column Tables `@ftable' and `@vtable' ----------------------- The `@ftable' and `@vtable' commands are the same as the `@table' command except that `@ftable' automatically enters each of the items in the first column of the table into the index of functions and `@vtable' automatically enters each of the items in the first column of the table into the index of variables. This simplifies the task of creating indices. Only the items on the same line as the `@item' commands are indexed, and they are indexed in exactly the form that they appear on that line. *Note Indices::, for more information about indices. Begin a two-column table using `@ftable' or `@vtable' by writing the @-command at the beginning of a line, followed on the same line by an argument that is a Texinfo command such as `@code', exactly as you would for an `@table' command; and end the table with an `@end ftable' or `@end vtable' command on a line by itself. See the example for `@table' in the previous section.  File: texinfo, Node: itemx, Prev: ftable vtable, Up: Two-column Tables `@itemx' -------- Use the `@itemx' command inside a table when you have two or more first column entries for the same item, each of which should appear on a line of its own. Use `@itemx' for all but the first entry; `@itemx' should always follow an `@item' command. The `@itemx' command works exactly like `@item' except that it does not generate extra vertical space above the first column text. For example, @table @code @item upcase @itemx downcase These two functions accept a character or a string as argument, and return the corresponding upper case (lower case) character or string. @end table This produces: `upcase' `downcase' These two functions accept a character or a string as argument, and return the corresponding upper case (lower case) character or string. (Note also that this example illustrates multi-line supporting text in a two-column table.)  File: texinfo, Node: Multi-column Tables, Prev: Two-column Tables, Up: Lists and Tables Multi-column Tables =================== `@multitable' allows you to construct tables with any number of columns, with each column having any width you like. You define the column widths on the `@multitable' line itself, and write each row of the actual table following an `@item' command, with columns separated by an `@tab' command. Finally, `@end multitable' completes the table. Details in the sections below. * Menu: * Multitable Column Widths:: Defining multitable column widths. * Multitable Rows:: Defining multitable rows, with examples.  File: texinfo, Node: Multitable Column Widths, Next: Multitable Rows, Up: Multi-column Tables Multitable Column Widths ------------------------ You can define the column widths for a multitable in two ways: as fractions of the line length; or with a prototype row. Mixing the two methods is not supported. In either case, the widths are defined entirely on the same line as the `@multitable' command. 1. To specify column widths as fractions of the line length, write `@columnfractions' and the decimal numbers (presumably less than 1) after the `@multitable' command, as in: @multitable @columnfractions .33 .33 .33 The fractions need not add up exactly to 1.0, as these do not. This allows you to produce tables that do not need the full line length. You can use a leading zero if you wish. 2. To specify a prototype row, write the longest entry for each column enclosed in braces after the `@multitable' command. For example: @multitable {some text for column one} {for column two} The first column will then have the width of the typeset `some text for column one', and the second column the width of `for column two'. The prototype entries need not appear in the table itself. Although we used simple text in this example, the prototype entries can contain Texinfo commands; markup commands such as `@code' are particularly likely to be useful.  File: texinfo, Node: Multitable Rows, Prev: Multitable Column Widths, Up: Multi-column Tables Multitable Rows --------------- After the `@multitable' command defining the column widths (see the previous section), you begin each row in the body of a multitable with `@item', and separate the column entries with `@tab'. Line breaks are not special within the table body, and you may break input lines in your source file as necessary. Here is a complete example of a multi-column table (the text is from `The GNU Emacs Manual', *note Splitting Windows: (emacs)Split Window.): @multitable @columnfractions .15 .45 .4 @item Key @tab Command @tab Description @item C-x 2 @tab @code{split-window-vertically} @tab Split the selected window into two windows, with one above the other. @item C-x 3 @tab @code{split-window-horizontally} @tab Split the selected window into two windows positioned side by side. @item C-Mouse-2 @tab @tab In the mode line or scroll bar of a window, split that window. @end multitable produces: Key Command Description C-x 2 `split-window-vertically' Split the selected window into two windows, with one above the other. C-x 3 `split-window-horizontally' Split the selected window into two windows positioned side by side. C-Mouse-2 In the mode line or scroll bar of a window, split that window.  File: texinfo, Node: Indices, Next: Insertions, Prev: Lists and Tables, Up: Top Indices ******* Using Texinfo, you can generate indices without having to sort and collate entries manually. In an index, the entries are listed in alphabetical order, together with information on how to find the discussion of each entry. In a printed manual, this information consists of page numbers. In an Info file, this information is a menu entry leading to the first node referenced. Texinfo provides several predefined kinds of index: an index for functions, an index for variables, an index for concepts, and so on. You can combine indices or use them for other than their canonical purpose. If you wish, you can define your own indices. * Menu: * Index Entries:: Choose different words for index entries. * Predefined Indices:: Use different indices for different kinds of entry. * Indexing Commands:: How to make an index entry. * Combining Indices:: How to combine indices. * New Indices:: How to define your own indices.  File: texinfo, Node: Index Entries, Next: Predefined Indices, Prev: Indices, Up: Indices Making Index Entries ==================== When you are making index entries, it is good practice to think of the different ways people may look for something. Different people _do not_ think of the same words when they look something up. A helpful index will have items indexed under all the different words that people may use. For example, one reader may think it obvious that the two-letter names for indices should be listed under "Indices, two-letter names", since the word "Index" is the general concept. But another reader may remember the specific concept of two-letter names and search for the entry listed as "Two letter names for indices". A good index will have both entries and will help both readers. Like typesetting, the construction of an index is a highly skilled, professional art, the subtleties of which are not appreciated until you need to do it yourself. *Note Printing Indices & Menus::, for information about printing an index at the end of a book or creating an index menu in an Info file.  File: texinfo, Node: Predefined Indices, Next: Indexing Commands, Prev: Index Entries, Up: Indices Predefined Indices ================== Texinfo provides six predefined indices: * A "concept index" listing concepts that are discussed. * A "function index" listing functions (such as entry points of libraries). * A "variables index" listing variables (such as global variables of libraries). * A "keystroke index" listing keyboard commands. * A "program index" listing names of programs. * A "data type index" listing data types (such as structures defined in header files). Not every manual needs all of these, and most manuals use two or three of them. This manual has two indices: a concept index and an @-command index (that is actually the function index but is called a command index in the chapter heading). Two or more indices can be combined into one using the `@synindex' or `@syncodeindex' commands. *Note Combining Indices::.  File: texinfo, Node: Indexing Commands, Next: Combining Indices, Prev: Predefined Indices, Up: Indices Defining the Entries of an Index ================================ The data to make an index come from many individual indexing commands scattered throughout the Texinfo source file. Each command says to add one entry to a particular index; after formatting, the index will give the current page number or node name as the reference. An index entry consists of an indexing command at the beginning of a line followed, on the rest of the line, by the entry. For example, this section begins with the following five entries for the concept index: @cindex Defining indexing entries @cindex Index entries @cindex Entries for an index @cindex Specifying index entries @cindex Creating index entries Each predefined index has its own indexing command--`@cindex' for the concept index, `@findex' for the function index, and so on. Concept index entries consist of text. The best way to write an index is to choose entries that are terse yet clear. If you can do this, the index often looks better if the entries are not capitalized, but written just as they would appear in the middle of a sentence. (Capitalize proper names and acronyms that always call for upper case letters.) This is the case convention we use in most GNU manuals' indices. If you don't see how to make an entry terse yet clear, make it longer and clear--not terse and confusing. If many of the entries are several words long, the index may look better if you use a different convention: to capitalize the first word of each entry. But do not capitalize a case-sensitive name such as a C or Lisp function name or a shell command; that would be a spelling error. Whichever case convention you use, please use it consistently! Entries in indices other than the concept index are symbol names in programming languages, or program names; these names are usually case-sensitive, so use upper and lower case as required for them. By default, entries for a concept index are printed in a small roman font and entries for the other indices are printed in a small `@code' font. You may change the way part of an entry is printed with the usual Texinfo commands, such as `@file' for file names and `@emph' for emphasis (*note Marking Text::). The six indexing commands for predefined indices are: `@cindex CONCEPT' Make an entry in the concept index for CONCEPT. `@findex FUNCTION' Make an entry in the function index for FUNCTION. `@vindex VARIABLE' Make an entry in the variable index for VARIABLE. `@kindex KEYSTROKE' Make an entry in the key index for KEYSTROKE. `@pindex PROGRAM' Make an entry in the program index for PROGRAM. `@tindex DATA TYPE' Make an entry in the data type index for DATA TYPE. *Caution:* Do not use a colon in an index entry. In Info, a colon separates the menu entry name from the node name, so a colon in the entry itself confuses Info. *Note The Parts of a Menu: Menu Parts, for more information about the structure of a menu entry. You are not actually required to use the predefined indices for their canonical purposes. For example, suppose you wish to index some C preprocessor macros. You could put them in the function index along with actual functions, just by writing `@findex' commands for them; then, when you print the "Function Index" as an unnumbered chapter, you could give it the title `Function and Macro Index' and all will be consistent for the reader. Or you could put the macros in with the data types by writing `@tindex' commands for them, and give that index a suitable title so the reader will understand. (*Note Printing Indices & Menus::.)  File: texinfo, Node: Combining Indices, Next: New Indices, Prev: Indexing Commands, Up: Indices Combining Indices ================= Sometimes you will want to combine two disparate indices such as functions and concepts, perhaps because you have few enough of one of them that a separate index for them would look silly. You could put functions into the concept index by writing `@cindex' commands for them instead of `@findex' commands, and produce a consistent manual by printing the concept index with the title `Function and Concept Index' and not printing the `Function Index' at all; but this is not a robust procedure. It works only if your document is never included as part of another document that is designed to have a separate function index; if your document were to be included with such a document, the functions from your document and those from the other would not end up together. Also, to make your function names appear in the right font in the concept index, you would need to enclose every one of them between the braces of `@code'. * Menu: * syncodeindex:: How to merge two indices, using `@code' font for the merged-from index. * synindex:: How to merge two indices, using the default font of the merged-to index.  File: texinfo, Node: syncodeindex, Next: synindex, Prev: Combining Indices, Up: Combining Indices `@syncodeindex' --------------- When you want to combine functions and concepts into one index, you should index the functions with `@findex' and index the concepts with `@cindex', and use the `@syncodeindex' command to redirect the function index entries into the concept index. The `@syncodeindex' command takes two arguments; they are the name of the index to redirect, and the name of the index to redirect it to. The template looks like this: @syncodeindex FROM TO For this purpose, the indices are given two-letter names: `cp' concept index `fn' function index `vr' variable index `ky' key index `pg' program index `tp' data type index Write an `@syncodeindex' command before or shortly after the end-of-header line at the beginning of a Texinfo file. For example, to merge a function index with a concept index, write the following: @syncodeindex fn cp This will cause all entries designated for the function index to merge in with the concept index instead. To merge both a variables index and a function index into a concept index, write the following: @syncodeindex vr cp @syncodeindex fn cp The `@syncodeindex' command puts all the entries from the `from' index (the redirected index) into the `@code' font, overriding whatever default font is used by the index to which the entries are now directed. This way, if you direct function names from a function index into a concept index, all the function names are printed in the `@code' font as you would expect.  File: texinfo, Node: synindex, Prev: syncodeindex, Up: Combining Indices `@synindex' ----------- The `@synindex' command is nearly the same as the `@syncodeindex' command, except that it does not put the `from' index entries into the `@code' font; rather it puts them in the roman font. Thus, you use `@synindex' when you merge a concept index into a function index. *Note Printing Indices & Menus::, for information about printing an index at the end of a book or creating an index menu in an Info file.  File: texinfo, Node: New Indices, Prev: Combining Indices, Up: Indices Defining New Indices ==================== In addition to the predefined indices, you may use the `@defindex' and `@defcodeindex' commands to define new indices. These commands create new indexing @-commands with which you mark index entries. The `@defindex 'command is used like this: @defindex NAME The name of an index should be a two letter word, such as `au'. For example: @defindex au This defines a new index, called the `au' index. At the same time, it creates a new indexing command, `@auindex', that you can use to make index entries. Use the new indexing command just as you would use a predefined indexing command. For example, here is a section heading followed by a concept index entry and two `au' index entries. @section Cognitive Semantics @cindex kinesthetic image schemas @auindex Johnson, Mark @auindex Lakoff, George (Evidently, `au' serves here as an abbreviation for "author".) Texinfo constructs the new indexing command by concatenating the name of the index with `index'; thus, defining an `au' index leads to the automatic creation of an `@auindex' command. Use the `@printindex' command to print the index, as you do with the predefined indices. For example: @node Author Index, Subject Index, , Top @unnumbered Author Index @printindex au The `@defcodeindex' is like the `@defindex' command, except that, in the printed output, it prints entries in an `@code' font instead of a roman font. Thus, it parallels the `@findex' command rather than the `@cindex' command. You should define new indices within or right after the end-of-header line of a Texinfo file, before any `@synindex' or `@syncodeindex' commands (*note Header::).  File: texinfo, Node: Insertions, Next: Breaks, Prev: Indices, Up: Top Special Insertions ****************** Texinfo provides several commands for inserting characters that have special meaning in Texinfo, such as braces, and for other graphic elements that do not correspond to simple characters you can type. * Menu: * Braces Atsigns:: How to insert braces, `@'. * Inserting Space:: How to insert the right amount of space within a sentence. * Inserting Accents:: How to insert accents and special characters. * Dots Bullets:: How to insert dots and bullets. * TeX and copyright:: How to insert the TeX logo and the copyright symbol. * pounds:: How to insert the pounds currency symbol. * minus:: How to insert a minus sign. * math:: How to format a mathematical expression. * Glyphs:: How to indicate results of evaluation, expansion of macros, errors, etc. * Footnotes:: How to include footnotes. * Images:: How to include graphics.  File: texinfo, Node: Braces Atsigns, Next: Inserting Space, Prev: Insertions, Up: Insertions Inserting @ and Braces ====================== `@' and curly braces are special characters in Texinfo. To insert these characters so they appear in text, you must put an `@' in front of these characters to prevent Texinfo from misinterpreting them. Do not put braces after any of these commands; they are not necessary. * Menu: * Inserting An Atsign:: How to insert `@'. * Inserting Braces:: How to insert `{' and `}'.  File: texinfo, Node: Inserting An Atsign, Next: Inserting Braces, Prev: Braces Atsigns, Up: Braces Atsigns Inserting `@' with @@ --------------------- `@@' stands for a single `@' in either printed or Info output. Do not put braces after an `@@' command.  File: texinfo, Node: Inserting Braces, Prev: Inserting An Atsign, Up: Braces Atsigns Inserting `{' and `}'with @{ and @} ----------------------------------- `@{' stands for a single `{' in either printed or Info output. `@}' stands for a single `}' in either printed or Info output. Do not put braces after either an `@{' or an `@}' command.  File: texinfo, Node: Inserting Space, Next: Inserting Accents, Prev: Braces Atsigns, Up: Insertions Inserting Space =============== The following sections describe commands that control spacing of various kinds within and after sentences. * Menu: * Not Ending a Sentence:: Sometimes a . doesn't end a sentence. * Ending a Sentence:: Sometimes it does. * Multiple Spaces:: Inserting multiple spaces. * dmn:: How to format a dimension.  File: texinfo, Node: Not Ending a Sentence, Next: Ending a Sentence, Up: Inserting Space Not Ending a Sentence --------------------- Depending on whether a period or exclamation point or question mark is inside or at the end of a sentence, less or more space is inserted after a period in a typeset manual. Since it is not always possible to determine when a period ends a sentence and when it is used in an abbreviation, special commands are needed in some circumstances. Usually, Texinfo can guess how to handle periods, so you do not need to use the special commands; you just enter a period as you would if you were using a typewriter, which means you put two spaces after the period, question mark, or exclamation mark that ends a sentence. Use the `@:' command after a period, question mark, exclamation mark, or colon that should not be followed by extra space. For example, use `@:' after periods that end abbreviations which are not at the ends of sentences. For example, The s.o.p.@: has three parts ... The s.o.p. has three parts ... produces The s.o.p. has three parts ... The s.o.p. has three parts ... (Incidentally, `s.o.p.' is an abbreviation for "Standard Operating Procedure".) `@:' has no effect on the Info output. Do not put braces after `@:'.  File: texinfo, Node: Ending a Sentence, Next: Multiple Spaces, Prev: Not Ending a Sentence, Up: Inserting Space Ending a Sentence ----------------- Use `@.' instead of a period, `@!' instead of an exclamation point, and `@?' instead of a question mark at the end of a sentence that ends with a single capital letter. Otherwise, TeX will think the letter is an abbreviation and will not insert the correct end-of-sentence spacing. Here is an example: Give it to M.I.B. and to M.E.W@. Also, give it to R.J.C@. Give it to M.I.B. and to M.E.W. Also, give it to R.J.C. produces Give it to M.I.B. and to M.E.W. Also, give it to R.J.C. Give it to M.I.B. and to M.E.W. Also, give it to R.J.C. In the Info file output, `@.' is equivalent to a simple `.'; likewise for `@!' and `@?'. The meanings of `@:' and `@.' in Texinfo are designed to work well with the Emacs sentence motion commands (*note Sentences: (emacs)Sentences.). Do not put braces after any of these commands.  File: texinfo, Node: Multiple Spaces, Next: dmn, Prev: Ending a Sentence, Up: Inserting Space Multiple Spaces --------------- Ordinarily, TeX collapses multiple whitespace characters (space, tab, and newline) into a single space. Info output, on the other hand, preserves whitespace as you type it, except for changing a newline into a space; this is why it is important to put two spaces at the end of sentences in Texinfo documents. Occasionally, you may want to actually insert several consecutive spaces, either for purposes of example (what your program does with multiple spaces as input), or merely for purposes of appearance in headings or lists. Texinfo supports three commands: `@SPACE', `@TAB', and `@NL', all of which insert a single space into the output. (Here, `@SPACE' represents an `@' character followed by a space, i.e., `@ ', and `TAB' and `NL' represent the tab character and end-of-line, i.e., when `@' is the last character on a line.) For example, Spacey@ @ @ @ example. produces Spacey example. Other possible uses of `@SPACE' have been subsumed by `@multitable' (*note Multi-column Tables::). Do not follow any of these commands with braces. To produce a non-breakable space, see *Note non-breakable space: w.  File: texinfo, Node: dmn, Prev: Multiple Spaces, Up: Inserting Space `@dmn'{DIMENSION}: Format a Dimension ------------------------------------- At times, you may want to write `12pt' or `8.5in' with little or no space between the number and the abbreviation for the dimension. You can use the `@dmn' command to do this. On seeing the command, TeX inserts just enough space for proper typesetting; the Info formatting commands insert no space at all, since the Info file does not require it. To use the `@dmn' command, write the number and then follow it immediately, with no intervening space, by `@dmn', and then by the dimension within braces. For example, A4 paper is 8.27@dmn{in} wide. produces A4 paper is 8.27in wide. Not everyone uses this style. Some people prefer `8.27 in.@:' or `8.27 inches' to `8.27@dmn{in}' in the Texinfo file. In these cases, however, the formatters may insert a line break between the number and the dimension, so use `@w' (*note w::). Also, if you write a period after an abbreviation within a sentence, you should write `@:' after the period to prevent TeX from inserting extra whitespace, as shown here. *Note Not Ending a Sentence::.  File: texinfo, Node: Inserting Accents, Next: Dots Bullets, Prev: Inserting Space, Up: Insertions Inserting Accents ================= Here is a table with the commands Texinfo provides for inserting floating accents. The commands with non-alphabetic names do not take braces around their argument (which is taken to be the next character). (Exception: `@,' _does_ take braces around its argument.) This is so as to make the source as convenient to type and read as possible, since accented characters are very common in some languages. Command Output What @"o o" umlaut accent @'o o' acute accent @,{c} c, cedilla accent @=o o= macron/overbar accent @^o o^ circumflex accent @`o o` grave accent @~o o~ tilde accent @dotaccent{o} o. overdot accent @H{o} o'' long Hungarian umlaut @ringaccent{o} o* ring accent @tieaccent{oo} oo[ tie-after accent @u{o} o( breve accent @ubaraccent{o} o_ underbar accent @udotaccent{o} .o underdot accent @v{o} o< hacek or check accent This table lists the Texinfo commands for inserting other characters commonly used in languages other than English. @exclamdown{} ! upside-down ! @questiondown{} ? upside-down ? @aa{},@AA{} aa,AA a,A with circle @ae{},@AE{} ae,AE ae,AE ligatures @dotless{i} i dotless i @dotless{j} j dotless j @l{},@L{} /l,/L suppressed-L,l @o{},@O{} /o,/O O,o with slash @oe{},@OE{} œ,Œoe,OE ligatures @ss{} ss es-zet or sharp S  File: texinfo, Node: Dots Bullets, Next: TeX and copyright, Prev: Inserting Accents, Up: Insertions Inserting Ellipsis and Bullets ============================== An "ellipsis" (a line of dots) is not typeset as a string of periods, so a special command is used for ellipsis in Texinfo. The `@bullet' command is special, too. Each of these commands is followed by a pair of braces, `{}', without any whitespace between the name of the command and the braces. (You need to use braces with these commands because you can use them next to other text; without the braces, the formatters would be confused. *Note @-Command Syntax: Command Syntax, for further information.) * Menu: * dots:: How to insert dots ... * bullet:: How to insert a bullet.  File: texinfo, Node: dots, Next: bullet, Up: Dots Bullets `@dots'{} (...) and `@enddots'{} (....) --------------------------------------- Use the `@dots{}' command to generate an ellipsis, which is three dots in a row, appropriately spaced, like this: `...'. Do not simply write three periods in the input file; that would work for the Info file output, but would produce the wrong amount of space between the periods in the printed manual. Similarly, the `@enddots{}' command generates an end-of-sentence ellipsis (four dots) ....  File: texinfo, Node: bullet, Prev: dots, Up: Dots Bullets `@bullet'{} (*) --------------- Use the `@bullet{}' command to generate a large round dot, or the closest possible thing to one. In Info, an asterisk is used. Here is a bullet: * When you use `@bullet' in `@itemize', you do not need to type the braces, because `@itemize' supplies them. (*Note `@itemize': itemize.)  File: texinfo, Node: TeX and copyright, Next: pounds, Prev: Dots Bullets, Up: Insertions Inserting TeX and the Copyright Symbol ====================================== The logo `TeX' is typeset in a special fashion and it needs an @-command. The copyright symbol, `(C)', is also special. Each of these commands is followed by a pair of braces, `{}', without any whitespace between the name of the command and the braces. * Menu: * tex:: How to insert the TeX logo. * copyright symbol:: How to use `@copyright'{}.  File: texinfo, Node: tex, Next: copyright symbol, Up: TeX and copyright `@TeX'{} (TeX) -------------- Use the `@TeX{}' command to generate `TeX'. In a printed manual, this is a special logo that is different from three ordinary letters. In Info, it just looks like `TeX'. The `@TeX{}' command is unique among Texinfo commands in that the `T' and the `X' are in upper case.  File: texinfo, Node: copyright symbol, Prev: tex, Up: TeX and copyright `@copyright'{} ((C)) -------------------- Use the `@copyright{}' command to generate `(C)'. In a printed manual, this is a `c' inside a circle, and in Info, this is `(C)'.  File: texinfo, Node: pounds, Next: minus, Prev: TeX and copyright, Up: Insertions `@pounds'{} (#): Pounds Sterling ================================ Use the `@pounds{}' command to generate `#'. In a printed manual, this is the symbol for the currency pounds sterling. In Info, it is a `#'. Other currency symbols are unfortunately not available.  File: texinfo, Node: minus, Next: math, Prev: pounds, Up: Insertions `@minus'{} (-): Inserting a Minus Sign ====================================== Use the `@minus{}' command to generate a minus sign. In a fixed-width font, this is a single hyphen, but in a proportional font, the symbol is the customary length for a minus sign--a little longer than a hyphen, shorter than an em-dash: `-' is a minus sign generated with `@minus{}', `-' is a hyphen generated with the character `-', `---' is an em-dash for text. In the fixed-width font used by Info, `@minus{}' is the same as a hyphen. You should not use `@minus{}' inside `@code' or `@example' because the width distinction is not made in the fixed-width font they use. When you use `@minus' to specify the mark beginning each entry in an itemized list, you do not need to type the braces (*note `@itemize': itemize..)  File: texinfo, Node: math, Next: Glyphs, Prev: minus, Up: Insertions `@math': Inserting Mathematical Expressions =========================================== You can write a short mathematical expression with the `@math' command. Write the mathematical expression between braces, like this: @math{(a + b)(a + b) = a^2 + 2ab + b^2} This produces the following in Info: (a + b)(a + b) = a^2 + 2ab + b^2 Thus, the `@math' command has no effect on the Info output. `@math' implies `@tex'. This not only makes it possible to write superscripts and subscripts (as in the above example), but also allows you to use any of the plain TeX math control sequences. It's simplest to use `\' instead of `@' for these commands. As in: @math{\sin 2\pi \equiv \cos 3\pi} which looks like the input in Info and HTML: \sin 2\pi \equiv \cos 3\pi For displayed equations, you must at present use TeX directly (*note Raw Formatter Commands::). ote non-breakable space: w.  File: texinfo, Node: dmn, Prev: Multiple Spaces, Up: Inserting Spac./info/texinfo-7 644 0 0 142761 7442531461 6721 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Glyphs, Next: Footnotes, Prev: math, Up: Insertions Glyphs for Examples =================== In Texinfo, code is often illustrated in examples that are delimited by `@example' and `@end example', or by `@lisp' and `@end lisp'. In such examples, you can indicate the results of evaluation or an expansion using `=>' or `==>'. Likewise, there are commands to insert glyphs to indicate printed output, error messages, equivalence of expressions, and the location of point. The glyph-insertion commands do not need to be used within an example, but most often they are. Every glyph-insertion command is followed by a pair of left- and right-hand braces. * Menu: * Glyphs Summary:: * result:: How to show the result of expression. * expansion:: How to indicate an expansion. * Print Glyph:: How to indicate printed output. * Error Glyph:: How to indicate an error message. * Equivalence:: How to indicate equivalence. * Point Glyph:: How to indicate the location of point.  File: texinfo, Node: Glyphs Summary, Next: result, Up: Glyphs Glyphs Summary -------------- Here are the different glyph commands: => `@result{}' points to the result of an expression. ==> `@expansion{}' shows the results of a macro expansion. -| `@print{}' indicates printed output. error--> `@error{}' indicates that the following text is an error message. == `@equiv{}' indicates the exact equivalence of two forms. -!- `@point{}' shows the location of point. * Menu: * result:: * expansion:: * Print Glyph:: * Error Glyph:: * Equivalence:: * Point Glyph::  File: texinfo, Node: result, Next: expansion, Prev: Glyphs Summary, Up: Glyphs `@result{}' (=>): Indicating Evaluation --------------------------------------- Use the `@result{}' command to indicate the result of evaluating an expression. The `@result{}' command is displayed as `=>' in Info and as a double stemmed arrow in the printed output. Thus, the following, (cdr '(1 2 3)) => (2 3) may be read as "`(cdr '(1 2 3))' evaluates to `(2 3)'".  File: texinfo, Node: expansion, Next: Print Glyph, Prev: result, Up: Glyphs `@expansion{}' (==>): Indicating an Expansion --------------------------------------------- When an expression is a macro call, it expands into a new expression. You can indicate the result of the expansion with the `@expansion{}' command. The `@expansion{}' command is displayed as `==>' in Info and as a long arrow with a flat base in the printed output. For example, the following @lisp (third '(a b c)) @expansion{} (car (cdr (cdr '(a b c)))) @result{} c @end lisp produces (third '(a b c)) ==> (car (cdr (cdr '(a b c)))) => c which may be read as: `(third '(a b c))' expands to `(car (cdr (cdr '(a b c))))'; the result of evaluating the expression is `c'. Often, as in this case, an example looks better if the `@expansion{}' and `@result{}' commands are indented five spaces.  File: texinfo, Node: Print Glyph, Next: Error Glyph, Prev: expansion, Up: Glyphs `@print{}' (-|): Indicating Printed Output ------------------------------------------ Sometimes an expression will print output during its execution. You can indicate the printed output with the `@print{}' command. The `@print{}' command is displayed as `-|' in Info and similarly, as a horizontal dash butting against a vertical bar, in the printed output. In the following example, the printed text is indicated with `-|', and the value of the expression follows on the last line. (progn (print 'foo) (print 'bar)) -| foo -| bar => bar In a Texinfo source file, this example is written as follows: @lisp (progn (print 'foo) (print 'bar)) @print{} foo @print{} bar @result{} bar @end lisp  File: texinfo, Node: Error Glyph, Next: Equivalence, Prev: Print Glyph, Up: Glyphs `@error{}' (error-->): Indicating an Error Message -------------------------------------------------- A piece of code may cause an error when you evaluate it. You can designate the error message with the `@error{}' command. The `@error{}' command is displayed as `error-->' in Info and as the word `error' in a box in the printed output. Thus, @lisp (+ 23 'x) @error{} Wrong type argument: integer-or-marker-p, x @end lisp produces (+ 23 'x) error--> Wrong type argument: integer-or-marker-p, x This indicates that the following error message is printed when you evaluate the expression: Wrong type argument: integer-or-marker-p, x `error-->' itself is not part of the error message.  File: texinfo, Node: Equivalence, Next: Point Glyph, Prev: Error Glyph, Up: Glyphs `@equiv{}' (==): Indicating Equivalence --------------------------------------- Sometimes two expressions produce identical results. You can indicate the exact equivalence of two forms with the `@equiv{}' command. The `@equiv{}' command is displayed as `==' in Info and as a three parallel horizontal lines in the printed output. Thus, @lisp (make-sparse-keymap) @equiv{} (list 'keymap) @end lisp produces (make-sparse-keymap) == (list 'keymap) This indicates that evaluating `(make-sparse-keymap)' produces identical results to evaluating `(list 'keymap)'.  File: texinfo, Node: Point Glyph, Prev: Equivalence, Up: Glyphs `@point{}' (-!-): Indicating Point in a Buffer ---------------------------------------------- Sometimes you need to show an example of text in an Emacs buffer. In such examples, the convention is to include the entire contents of the buffer in question between two lines of dashes containing the buffer name. You can use the `@point{}' command to show the location of point in the text in the buffer. (The symbol for point, of course, is not part of the text in the buffer; it indicates the place _between_ two characters where point is located.) The `@point{}' command is displayed as `-!-' in Info and as a small five pointed star in the printed output. The following example shows the contents of buffer `foo' before and after evaluating a Lisp command to insert the word `changed'. ---------- Buffer: foo ---------- This is the -!-contents of foo. ---------- Buffer: foo ---------- (insert "changed ") => nil ---------- Buffer: foo ---------- This is the changed -!-contents of foo. ---------- Buffer: foo ---------- In a Texinfo source file, the example is written like this: @example ---------- Buffer: foo ---------- This is the @point{}contents of foo. ---------- Buffer: foo ---------- (insert "changed ") @result{} nil ---------- Buffer: foo ---------- This is the changed @point{}contents of foo. ---------- Buffer: foo ---------- @end example  File: texinfo, Node: Footnotes, Next: Images, Prev: Glyphs, Up: Insertions Footnotes ========= A "footnote" is for a reference that documents or elucidates the primary text.(1) (*note Footnotes-Footnote-1::) * Menu: * Footnote Commands:: How to write a footnote in Texinfo. * Footnote Styles:: Controlling how footnotes appear in Info.  File: texinfo, Node: Footnotes-Footnotes, Up: Footnotes (1) A footnote should complement or expand upon the primary text, but a reader should not need to read a footnote to understand the primary text. For a thorough discussion of footnotes, see `The Chicago Manual of Style', which is published by the University of Chicago Press.  File: texinfo, Node: Footnote Commands, Next: Footnote Styles, Up: Footnotes Footnote Commands ----------------- In Texinfo, footnotes are created with the `@footnote' command. This command is followed immediately by a left brace, then by the text of the footnote, and then by a terminating right brace. Footnotes may be of any length (they will be broken across pages if necessary), but are usually short. The template is: ordinary text@footnote{TEXT OF FOOTNOTE} As shown here, the `@footnote' command should come right after the text being footnoted, with no intervening space; otherwise, the footnote marker might end up starting a line. For example, this clause is followed by a sample footnote(1) (*note Footnote Commands-Footnote-1::); in the Texinfo source, it looks like this: ...a sample footnote@footnote{Here is the sample footnote.}; in the Texinfo source... As you can see, the source includes two punctuation marks next to each other; in this case, `.};' is the sequence. This is normal (the first ends the footnote and the second belongs to the sentence being footnoted), so don't worry that it looks odd. In a printed manual or book, the reference mark for a footnote is a small, superscripted number; the text of the footnote appears at the bottom of the page, below a horizontal line. In Info, the reference mark for a footnote is a pair of parentheses with the footnote number between them, like this: `(1)'. The reference mark is followed by a cross-reference link to the footnote's text. In the HTML output, footnote references are marked with a small, superscripted number which is rendered as a hypertext link to the footnote text. By the way, footnotes in the argument of an `@item' command for a `@table' must be on the same line as the `@item' (as usual). *Note Two-column Tables::.  File: texinfo, Node: Footnote Commands-Footnotes, Up: Footnote Commands (1) Here is the sample footnote.  File: texinfo, Node: Footnote Styles, Prev: Footnote Commands, Up: Footnotes Footnote Styles --------------- Info has two footnote styles, which determine where the text of the footnote is located: * In the `End' node style, all the footnotes for a single node are placed at the end of that node. The footnotes are separated from the rest of the node by a line of dashes with the word `Footnotes' within it. Each footnote begins with an `(N)' reference mark. Here is an example of a single footnote in the end of node style: --------- Footnotes --------- (1) Here is a sample footnote. * In the `Separate' node style, all the footnotes for a single node are placed in an automatically constructed node of their own. In this style, a "footnote reference" follows each `(N)' reference mark in the body of the node. The footnote reference is actually a cross reference which you use to reach the footnote node. The name of the node with the footnotes is constructed by appending `-Footnotes' to the name of the node that contains the footnotes. (Consequently, the footnotes' node for the `Footnotes' node is `Footnotes-Footnotes'!) The footnotes' node has an `Up' node pointer that leads back to its parent node. Here is how the first footnote in this manual looks after being formatted for Info in the separate node style: File: texinfo.info Node: Overview-Footnotes, Up: Overview (1) The first syllable of "Texinfo" is pronounced like "speck", not "hex". ... A Texinfo file may be formatted into an Info file with either footnote style. Use the `@footnotestyle' command to specify an Info file's footnote style. Write this command at the beginning of a line followed by an argument, either `end' for the end node style or `separate' for the separate node style. For example, @footnotestyle end or @footnotestyle separate Write an `@footnotestyle' command before or shortly after the end-of-header line at the beginning of a Texinfo file. (If you include the `@footnotestyle' command between the start-of-header and end-of-header lines, the region formatting commands will format footnotes as specified.) If you do not specify a footnote style, the formatting commands use their default style. Currently, `texinfo-format-buffer' and `texinfo-format-region' use the `separate' style and `makeinfo' uses the `end' style. This chapter contains two footnotes.  File: texinfo, Node: Images, Prev: Footnotes, Up: Insertions Inserting Images ================ You can insert an image given in an external file with the `@image' command: @image{FILENAME, [WIDTH], [HEIGHT], [ALTTEXT], [EXTENSION]} The FILENAME argument is mandatory, and must not have an extension, because the different processors support different formats: * TeX reads the file `FILENAME.eps' (Encapsulated PostScript format). * PDFTeX reads `FILENAME.pdf' (Adobe's Portable Document Format). * `makeinfo' uses `FILENAME.txt' verbatim for Info output (more or less as if it was an `@example'). * `makeinfo' uses the optional fifth argument to `@image' for the extension if you supply it. For example: @image{foo,,,,xpm} will cause `makeinfo --html' to try `foo.xpm'. If you do not supply the optional fifth argument, `makeinfo ---html' first tries `FILENAME.png'; if that does not exist, it tries `FILENAME.jpg'. If that does not exist either, it complains. (We cannot support GIF format directly due to software patents.) The optional WIDTH and HEIGHT arguments specify the size to scale the image to (they are ignored for Info output). If neither is specified, the image is presented in its natural size (given in the file); if only one is specified, the other is scaled proportionately; and if both are specified, both are respected, thus possibly distorting the original image by changing its aspect ratio. The WIDTH and HEIGHT may be specified using any valid TeX dimension, namely: pt point (72.27pt = 1in) pc pica (1pc = 12pt) bp big point (72bp = 1in) in inch cm centimeter (2.54cm = 1in) mm millimeter (10mm = 1cm) dd dido^t point (1157dd = 1238pt) cc cicero (1cc = 12dd) sp scaled point (65536sp = 1pt) For example, the following will scale a file `ridt.eps' to one inch vertically, with the width scaled proportionately: @image{ridt,,1in} For `@image' to work with TeX, the file `epsf.tex' must be installed somewhere that TeX can find it. (The standard location is `TEXMF/tex/generic/dvips/epsf.tex', where TEXMF is a root of your TeX directory tree.) This file is included in the Texinfo distribution and is also available from `ftp://tug.org/tex/epsf.tex', among other places. `@image' can be used within a line as well as for displayed figures. Therefore, if you intend it to be displayed, be sure to leave a blank line before the command, or the output will run into the preceding text. When producing html, `makeinfo' sets the "alt attribute" for inline images to the optional fourth argument to `@image', if supplied. If not supplied, `makeinfo' uses the full file name of the image being displayed.  File: texinfo, Node: Breaks, Next: Definition Commands, Prev: Insertions, Up: Top Making and Preventing Breaks **************************** Usually, a Texinfo file is processed both by TeX and by one of the Info formatting commands. Line, paragraph, or page breaks sometimes occur in the `wrong' place in one or other form of output. You must ensure that text looks right both in the printed manual and in the Info file. For example, in a printed manual, page breaks may occur awkwardly in the middle of an example; to prevent this, you can hold text together using a grouping command that keeps the text from being split across two pages. Conversely, you may want to force a page break where none would occur normally. Fortunately, problems like these do not often arise. When they do, use the break, break prevention, or pagination commands. * Menu: * Break Commands:: Cause and prevent splits. * Line Breaks:: How to force a single line to use two lines. * - and hyphenation:: How to tell TeX about hyphenation points. * w:: How to prevent unwanted line breaks. * sp:: How to insert blank lines. * page:: How to force the start of a new page. * group:: How to prevent unwanted page breaks. * need:: Another way to prevent unwanted page breaks.  File: texinfo, Node: Break Commands, Next: Line Breaks, Prev: Breaks, Up: Breaks Break Commands ============== The break commands create or allow line and paragraph breaks: `@*' Force a line break. `@sp N' Skip N blank lines. `@-' Insert a discretionary hyphen. `@hyphenation{HY-PHEN-A-TED WORDS}' Define hyphen points in HY-PHEN-A-TED WORDS. The line-break-prevention command holds text together all on one line: `@w{TEXT}' Prevent TEXT from being split and hyphenated across two lines. The pagination commands apply only to printed output, since Info files do not have pages. `@page' Start a new page in the printed manual. `@group' Hold text together that must appear on one printed page. `@need MILS' Start a new printed page if not enough space on this one.  File: texinfo, Node: Line Breaks, Next: - and hyphenation, Prev: Break Commands, Up: Breaks `@*': Generate Line Breaks ========================== The `@*' command forces a line break in both the printed manual and in Info. For example, This line @* is broken @*in two places. produces This line is broken in two places. (Note that the space after the first `@*' command is faithfully carried down to the next line.) The `@*' command is often used in a file's copyright page: This is edition 2.0 of the Texinfo documentation,@* and is for ... In this case, the `@*' command keeps TeX from stretching the line across the whole page in an ugly manner. *Please note:* Do not write braces after an `@*' command; they are not needed. Do not write an `@refill' command at the end of a paragraph containing an `@*' command; it will cause the paragraph to be refilled after the line break occurs, negating the effect of the line break.  File: texinfo, Node: - and hyphenation, Next: w, Prev: Line Breaks, Up: Breaks `@-' and `@hyphenation': Helping TeX hyphenate ============================================== Although TeX's hyphenation algorithm is generally pretty good, it does miss useful hyphenation points from time to time. (Or, far more rarely, insert an incorrect hyphenation.) So, for documents with an unusual vocabulary or when fine-tuning for a printed edition, you may wish to help TeX out. Texinfo supports two commands for this: `@-' Insert a discretionary hyphen, i.e., a place where TeX can (but does not have to) hyphenate. This is especially useful when you notice an overfull hbox is due to TeX missing a hyphenation (*note Overfull hboxes::). TeX will not insert any hyphenation points in a word containing `@-'. `@hyphenation{HY-PHEN-A-TED WORDS}' Tell TeX how to hyphenate HY-PHEN-A-TED WORDS. As shown, you put a `-' at each hyphenation point. For example: @hyphenation{man-u-script man-u-scripts} TeX only uses the specified hyphenation points when the words match exactly, so give all necessary variants. Info output is not hyphenated, so these commands have no effect there.  File: texinfo, Node: w, Next: sp, Prev: - and hyphenation, Up: Breaks `@w'{TEXT}: Prevent Line Breaks =============================== `@w{TEXT}' outputs TEXT and prohibits line breaks within TEXT. You can use the `@w' command to prevent TeX from automatically hyphenating a long name or phrase that happens to fall near the end of a line. For example: You can copy GNU software from @w{@samp{ftp.gnu.org}}. produces You can copy GNU software from `ftp.gnu.org'. You can also use `@w' to produce a non-breakable space: None of the formatters will break at this@w{ }space.  File: texinfo, Node: sp, Next: page, Prev: w, Up: Breaks `@sp' N: Insert Blank Lines =========================== A line beginning with and containing only `@sp N' generates N blank lines of space in both the printed manual and the Info file. `@sp' also forces a paragraph break. For example, @sp 2 generates two blank lines. The `@sp' command is most often used in the title page.  File: texinfo, Node: page, Next: group, Prev: sp, Up: Breaks `@page': Start a New Page ========================= A line containing only `@page' starts a new page in a printed manual. The command has no effect on Info files since they are not paginated. An `@page' command is often used in the `@titlepage' section of a Texinfo file to start the copyright page.  File: texinfo, Node: group, Next: need, Prev: page, Up: Breaks `@group': Prevent Page Breaks ============================= The `@group' command (on a line by itself) is used inside an `@example' or similar construct to begin an unsplittable vertical group, which will appear entirely on one page in the printed output. The group is terminated by a line containing only `@end group'. These two lines produce no output of their own, and in the Info file output they have no effect at all. Although `@group' would make sense conceptually in a wide variety of contexts, its current implementation works reliably only within `@example' and variants, and within `@display', `@format', `@flushleft' and `@flushright'. *Note Quotations and Examples::. (What all these commands have in common is that each line of input produces a line of output.) In other contexts, `@group' can cause anomalous vertical spacing. This formatting requirement means that you should write: @example @group ... @end group @end example with the `@group' and `@end group' commands inside the `@example' and `@end example' commands. The `@group' command is most often used to hold an example together on one page. In this Texinfo manual, more than 100 examples contain text that is enclosed between `@group' and `@end group'. If you forget to end a group, you may get strange and unfathomable error messages when you run TeX. This is because TeX keeps trying to put the rest of the Texinfo file onto the one page and does not start to generate error messages until it has processed considerable text. It is a good rule of thumb to look for a missing `@end group' if you get incomprehensible error messages in TeX.  File: texinfo, Node: need, Prev: group, Up: Breaks `@need MILS': Prevent Page Breaks ================================= A line containing only `@need N' starts a new page in a printed manual if fewer than N mils (thousandths of an inch) remain on the current page. Do not use braces around the argument N. The `@need' command has no effect on Info files since they are not paginated. This paragraph is preceded by an `@need' command that tells TeX to start a new page if fewer than 800 mils (eight-tenths inch) remain on the page. It looks like this: @need 800 This paragraph is preceded by ... The `@need' command is useful for preventing orphans (single lines at the bottoms of printed pages).  File: texinfo, Node: Definition Commands, Next: Conditionals, Prev: Breaks, Up: Top Definition Commands ******************* The `@deffn' command and the other "definition commands" enable you to describe functions, variables, macros, commands, user options, special forms and other such artifacts in a uniform format. In the Info file, a definition causes the entity category--`Function', `Variable', or whatever--to appear at the beginning of the first line of the definition, followed by the entity's name and arguments. In the printed manual, the command causes TeX to print the entity's name and its arguments on the left margin and print the category next to the right margin. In both output formats, the body of the definition is indented. Also, the name of the entity is entered into the appropriate index: `@deffn' enters the name into the index of functions, `@defvr' enters it into the index of variables, and so on. A manual need not and should not contain more than one definition for a given name. An appendix containing a summary should use `@table' rather than the definition commands. * Menu: * Def Cmd Template:: How to structure a description using a definition command. * Optional Arguments:: How to handle optional and repeated arguments. * deffnx:: How to group two or more `first' lines. * Def Cmds in Detail:: All the definition commands. * Def Cmd Conventions:: Conventions for writing definitions. * Sample Function Definition::  File: texinfo, Node: Def Cmd Template, Next: Optional Arguments, Prev: Definition Commands, Up: Definition Commands The Template for a Definition ============================= The `@deffn' command is used for definitions of entities that resemble functions. To write a definition using the `@deffn' command, write the `@deffn' command at the beginning of a line and follow it on the same line by the category of the entity, the name of the entity itself, and its arguments (if any). Then write the body of the definition on succeeding lines. (You may embed examples in the body.) Finally, end the definition with an `@end deffn' command written on a line of its own. (The other definition commands follow the same format.) The template for a definition looks like this: @deffn CATEGORY NAME ARGUMENTS... BODY-OF-DEFINITION @end deffn For example, @deffn Command forward-word count This command moves point forward @var{count} words (or backward if @var{count} is negative). ... @end deffn produces - Command: forward-word count This function moves point forward COUNT words (or backward if COUNT is negative). ... Capitalize the category name like a title. If the name of the category contains spaces, as in the phrase `Interactive Command', write braces around it. For example: @deffn {Interactive Command} isearch-forward ... @end deffn Otherwise, the second word will be mistaken for the name of the entity. Some of the definition commands are more general than others. The `@deffn' command, for example, is the general definition command for functions and the like--for entities that may take arguments. When you use this command, you specify the category to which the entity belongs. The `@deffn' command possesses three predefined, specialized variations, `@defun', `@defmac', and `@defspec', that specify the category for you: "Function", "Macro", and "Special Form" respectively. (In Lisp, a special form is an entity much like a function.) The `@defvr' command also is accompanied by several predefined, specialized variations for describing particular kinds of variables. The template for a specialized definition, such as `@defun', is similar to the template for a generalized definition, except that you do not need to specify the category: @defun NAME ARGUMENTS... BODY-OF-DEFINITION @end defun Thus, @defun buffer-end flag This function returns @code{(point-min)} if @var{flag} is less than 1, @code{(point-max)} otherwise. ... @end defun produces - Function: buffer-end flag This function returns `(point-min)' if FLAG is less than 1, `(point-max)' otherwise. ... *Note Sample Function Definition: Sample Function Definition, for a more detailed example of a function definition, including the use of `@example' inside the definition. The other specialized commands work like `@defun'. Note that, due to implementation difficulties, macros are not expanded in `@deffn' and all the other definition commands.  File: texinfo, Node: Optional Arguments, Next: deffnx, Prev: Def Cmd Template, Up: Definition Commands Optional and Repeated Arguments =============================== Some entities take optional or repeated arguments, which may be specified by a distinctive glyph that uses square brackets and ellipses. For example, a special form often breaks its argument list into separate arguments in more complicated ways than a straightforward function. An argument enclosed within square brackets is optional. Thus, [OPTIONAL-ARG] means that OPTIONAL-ARG is optional. An argument followed by an ellipsis is optional and may be repeated more than once. Thus, REPEATED-ARGS... stands for zero or more arguments. Parentheses are used when several arguments are grouped into additional levels of list structure in Lisp. Here is the `@defspec' line of an example of an imaginary special form: - Special Form: foobar (VAR [FROM TO [INC]]) BODY... In this example, the arguments FROM and TO are optional, but must both be present or both absent. If they are present, INC may optionally be specified as well. These arguments are grouped with the argument VAR into a list, to distinguish them from BODY, which includes all remaining elements of the form. In a Texinfo source file, this `@defspec' line is written like this (except it would not be split over two lines, as it is in this example). @defspec foobar (@var{var} [@var{from} @var{to} [@var{inc}]]) @var{body}@dots{} The function is listed in the Command and Variable Index under `foobar'.  File: texinfo, Node: deffnx, Next: Def Cmds in Detail, Prev: Optional Arguments, Up: Definition Commands Two or More `First' Lines ========================= To create two or more `first' or header lines for a definition, follow the first `@deffn' line by a line beginning with `@deffnx'. The `@deffnx' command works exactly like `@deffn' except that it does not generate extra vertical white space between it and the preceding line. For example, @deffn {Interactive Command} isearch-forward @deffnx {Interactive Command} isearch-backward These two search commands are similar except ... @end deffn produces - Interactive Command: isearch-forward - Interactive Command: isearch-backward These two search commands are similar except ... Each definition command has an `x' form: `@defunx', `@defvrx', `@deftypefunx', etc. The `x' forms work just like `@itemx'; see *Note `@itemx': itemx.  File: texinfo, Node: Def Cmds in Detail, Next: Def Cmd Conventions, Prev: deffnx, Up: Definition Commands The Definition Commands ======================= Texinfo provides more than a dozen definition commands, all of which are described in this section. The definition commands automatically enter the name of the entity in the appropriate index: for example, `@deffn', `@defun', and `@defmac' enter function names in the index of functions; `@defvr' and `@defvar' enter variable names in the index of variables. Although the examples that follow mostly illustrate Lisp, the commands can be used for other programming languages. * Menu: * Functions Commands:: Commands for functions and similar entities. * Variables Commands:: Commands for variables and similar entities. * Typed Functions:: Commands for functions in typed languages. * Typed Variables:: Commands for variables in typed languages. * Abstract Objects:: Commands for object-oriented programming. * Data Types:: The definition command for data types.  File: texinfo, Node: Functions Commands, Next: Variables Commands, Prev: Def Cmds in Detail, Up: Def Cmds in Detail Functions and Similar Entities ------------------------------ This section describes the commands for describing functions and similar entities: `@deffn CATEGORY NAME ARGUMENTS...' The `@deffn' command is the general definition command for functions, interactive commands, and similar entities that may take arguments. You must choose a term to describe the category of entity being defined; for example, "Function" could be used if the entity is a function. The `@deffn' command is written at the beginning of a line and is followed on the same line by the category of entity being described, the name of this particular entity, and its arguments, if any. Terminate the definition with `@end deffn' on a line of its own. For example, here is a definition: @deffn Command forward-char nchars Move point forward @var{nchars} characters. @end deffn This shows a rather terse definition for a "command" named `forward-char' with one argument, NCHARS. `@deffn' prints argument names such as NCHARS in italics or upper case, as if `@var' had been used, because we think of these names as metasyntactic variables--they stand for the actual argument values. Within the text of the description, write an argument name explicitly with `@var' to refer to the value of the argument. In the example above, we used `@var{nchars}' in this way. The template for `@deffn' is: @deffn CATEGORY NAME ARGUMENTS... BODY-OF-DEFINITION @end deffn `@defun NAME ARGUMENTS...' The `@defun' command is the definition command for functions. `@defun' is equivalent to `@deffn Function ...'. For example, @defun set symbol new-value Change the value of the symbol @var{symbol} to @var{new-value}. @end defun shows a rather terse definition for a function `set' whose arguments are SYMBOL and NEW-VALUE. The argument names on the `@defun' line automatically appear in italics or upper case as if they were enclosed in `@var'. Terminate the definition with `@end defun' on a line of its own. The template is: @defun FUNCTION-NAME ARGUMENTS... BODY-OF-DEFINITION @end defun `@defun' creates an entry in the index of functions. `@defmac NAME ARGUMENTS...' The `@defmac' command is the definition command for macros. `@defmac' is equivalent to `@deffn Macro ...' and works like `@defun'. `@defspec NAME ARGUMENTS...' The `@defspec' command is the definition command for special forms. (In Lisp, a special form is an entity much like a function, *note Special Forms: (elisp)Special Forms..) `@defspec' is equivalent to `@deffn {Special Form} ...' and works like `@defun'.  File: texinfo, Node: Variables Commands, Next: Typed Functions, Prev: Functions Commands, Up: Def Cmds in Detail Variables and Similar Entities ------------------------------ Here are the commands for defining variables and similar entities: `@defvr CATEGORY NAME' The `@defvr' command is a general definition command for something like a variable--an entity that records a value. You must choose a term to describe the category of entity being defined; for example, "Variable" could be used if the entity is a variable. Write the `@defvr' command at the beginning of a line and follow it on the same line by the category of the entity and the name of the entity. Capitalize the category name like a title. If the name of the category contains spaces, as in the name "User Option", enclose it in braces. Otherwise, the second word will be mistaken for the name of the entity. For example, @defvr {User Option} fill-column This buffer-local variable specifies the maximum width of filled lines. ... @end defvr Terminate the definition with `@end defvr' on a line of its own. The template is: @defvr CATEGORY NAME BODY-OF-DEFINITION @end defvr `@defvr' creates an entry in the index of variables for NAME. `@defvar NAME' The `@defvar' command is the definition command for variables. `@defvar' is equivalent to `@defvr Variable ...'. For example: @defvar kill-ring ... @end defvar The template is: @defvar NAME BODY-OF-DEFINITION @end defvar `@defvar' creates an entry in the index of variables for NAME. `@defopt NAME' The `@defopt' command is the definition command for "user options", i.e., variables intended for users to change according to taste; Emacs has many such (*note Variables: (emacs)Variables.). `@defopt' is equivalent to `@defvr {User Option} ...' and works like `@defvar'.  File: texinfo, Node: Typed Functions, Next: Typed Variables, Prev: Variables Commands, Up: Def Cmds in Detail Functions in Typed Languages ---------------------------- The `@deftypefn' command and its variations are for describing functions in languages in which you must declare types of variables and functions, such as C and C++. `@deftypefn CATEGORY DATA-TYPE NAME ARGUMENTS...' The `@deftypefn' command is the general definition command for functions and similar entities that may take arguments and that are typed. The `@deftypefn' command is written at the beginning of a line and is followed on the same line by the category of entity being described, the type of the returned value, the name of this particular entity, and its arguments, if any. For example, @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar}) ... @end deftypefn (where the text before the "...", shown above as two lines, would actually be a single line in a real Texinfo file) produces the following in Info: -- Library Function: int foobar (int FOO, float BAR) ... This means that `foobar' is a "library function" that returns an `int', and its arguments are FOO (an `int') and BAR (a `float'). The argument names that you write in `@deftypefn' are not subject to an implicit `@var'--since the actual names of the arguments in `@deftypefn' are typically scattered among data type names and keywords, Texinfo cannot find them without help. Instead, you must write `@var' explicitly around the argument names. In the example above, the argument names are `foo' and `bar'. The template for `@deftypefn' is: @deftypefn CATEGORY DATA-TYPE NAME ARGUMENTS ... BODY-OF-DESCRIPTION @end deftypefn Note that if the CATEGORY or DATA TYPE is more than one word then it must be enclosed in braces to make it a single argument. If you are describing a procedure in a language that has packages, such as Ada, you might consider using `@deftypefn' in a manner somewhat contrary to the convention described in the preceding paragraphs. For example: @deftypefn stacks private push (@var{s}:in out stack; @var{n}:in integer) ... @end deftypefn (The `@deftypefn' arguments are shown split into three lines, but would be a single line in a real Texinfo file.) In this instance, the procedure is classified as belonging to the package `stacks' rather than classified as a `procedure' and its data type is described as `private'. (The name of the procedure is `push', and its arguments are S and N.) `@deftypefn' creates an entry in the index of functions for NAME. `@deftypefun DATA-TYPE NAME ARGUMENTS...' The `@deftypefun' command is the specialized definition command for functions in typed languages. The command is equivalent to `@deftypefn Function ...'. Thus, @deftypefun int foobar (int @var{foo}, float @var{bar}) ... @end deftypefun produces the following in Info: -- Function: int foobar (int FOO, float BAR) ... The template is: @deftypefun TYPE NAME ARGUMENTS... BODY-OF-DESCRIPTION @end deftypefun `@deftypefun' creates an entry in the index of functions for NAME.  File: texinfo, Node: Typed Variables, Next: Abstract Objects, Prev: Typed Functions, Up: Def Cmds in Detail Variables in Typed Languages ---------------------------- Variables in typed languages are handled in a manner similar to functions in typed languages. *Note Typed Functions::. The general definition command `@deftypevr' corresponds to `@deftypefn' and the specialized definition command `@deftypevar' corresponds to `@deftypefun'. `@deftypevr CATEGORY DATA-TYPE NAME' The `@deftypevr' command is the general definition command for something like a variable in a typed language--an entity that records a value. You must choose a term to describe the category of the entity being defined; for example, "Variable" could be used if the entity is a variable. The `@deftypevr' command is written at the beginning of a line and is followed on the same line by the category of the entity being described, the data type, and the name of this particular entity. For example: @deftypevr {Global Flag} int enable ... @end deftypevr produces the following in Info: -- Global Flag: int enable ... The template is: @deftypevr CATEGORY DATA-TYPE NAME BODY-OF-DESCRIPTION @end deftypevr `@deftypevr' creates an entry in the index of variables for NAME. `@deftypevar DATA-TYPE NAME' The `@deftypevar' command is the specialized definition command for variables in typed languages. `@deftypevar' is equivalent to `@deftypevr Variable ...'. For example: @deftypevar int fubar ... @end deftypevar produces the following in Info: -- Variable: int fubar ... The template is: @deftypevar DATA-TYPE NAME BODY-OF-DESCRIPTION @end deftypevar `@deftypevar' creates an entry in the index of variables for NAME.  File: texinfo, Node: Abstract Objects, Next: Data Types, Prev: Typed Variables, Up: Def Cmds in Detail Object-Oriented Programming --------------------------- Here are the commands for formatting descriptions about abstract objects, such as are used in object-oriented programming. A class is a defined type of abstract object. An instance of a class is a particular object that has the type of the class. An instance variable is a variable that belongs to the class but for which each instance has its own value. In a definition, if the name of a class is truly a name defined in the programming system for a class, then you should write an `@code' around it. Otherwise, it is printed in the usual text font. `@defcv CATEGORY CLASS NAME' The `@defcv' command is the general definition command for variables associated with classes in object-oriented programming. The `@defcv' command is followed by three arguments: the category of thing being defined, the class to which it belongs, and its name. Thus, @defcv {Class Option} Window border-pattern ... @end defcv illustrates how you would write the first line of a definition of the `border-pattern' class option of the class `Window'. The template is: @defcv CATEGORY CLASS NAME ... @end defcv `@defcv' creates an entry in the index of variables. `@defivar CLASS NAME' The `@defivar' command is the definition command for instance variables in object-oriented programming. `@defivar' is equivalent to `@defcv {Instance Variable} ...' The template is: @defivar CLASS INSTANCE-VARIABLE-NAME BODY-OF-DEFINITION @end defivar `@defivar' creates an entry in the index of variables. `@deftypeivar CLASS DATA-TYPE NAME' The `@deftypeivar' command is the definition command for typed instance variables in object-oriented programming. It is similar to `@defivar' with the addition of the DATA-TYPE parameter to specify the type of the instance variable. `@deftypeivar' creates an entry in the index of variables. `@defop CATEGORY CLASS NAME ARGUMENTS...' The `@defop' command is the general definition command for entities that may resemble methods in object-oriented programming. These entities take arguments, as functions do, but are associated with particular classes of objects. For example, some systems have constructs called "wrappers" that are associated with classes as methods are, but that act more like macros than like functions. You could use `@defop Wrapper' to describe one of these. Sometimes it is useful to distinguish methods and "operations". You can think of an operation as the specification for a method. Thus, a window system might specify that all window classes have a method named `expose'; we would say that this window system defines an `expose' operation on windows in general. Typically, the operation has a name and also specifies the pattern of arguments; all methods that implement the operation must accept the same arguments, since applications that use the operation do so without knowing which method will implement it. Often it makes more sense to document operations than methods. For example, window application developers need to know about the `expose' operation, but need not be concerned with whether a given class of windows has its own method to implement this operation. To describe this operation, you would write: @defop Operation windows expose The `@defop' command is written at the beginning of a line and is followed on the same line by the overall name of the category of operation, the name of the class of the operation, the name of the operation, and its arguments, if any. The template is: @defop CATEGORY CLASS NAME ARGUMENTS... BODY-OF-DEFINITION @end defop `@defop' creates an entry, such as ``expose' on `windows'', in the index of functions. `@deftypeop CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...' The `@deftypeop' command is the definition command for typed operations in object-oriented programming. It is similar to `@defop' with the addition of the DATA-TYPE parameter to specify the return type of the method. `@deftypeop' creates an entry in the index of functions. `@defmethod CLASS NAME ARGUMENTS...' The `@defmethod' command is the definition command for methods in object-oriented programming. A method is a kind of function that implements an operation for a particular class of objects and its subclasses. `@defmethod' is equivalent to `@defop Method ...'. The command is written at the beginning of a line and is followed by the name of the class of the method, the name of the method, and its arguments, if any. For example: @defmethod `bar-class' bar-method argument ... @end defmethod illustrates the definition for a method called `bar-method' of the class `bar-class'. The method takes an argument. The template is: @defmethod CLASS METHOD-NAME ARGUMENTS... BODY-OF-DEFINITION @end defmethod `@defmethod' creates an entry, such as ``bar-method' on `bar-class'', in the index of functions. `@deftypemethod CLASS DATA-TYPE NAME ARGUMENTS...' The `@deftypemethod' command is the definition command for methods in object-oriented typed languages, such as C++ and Java. It is similar to the `@defmethod' command with the addition of the DATA-TYPE parameter to specify the return type of the method.  File: texinfo, Node: Data Types, Prev: Abstract Objects, Up: Def Cmds in Detail Data Types ---------- Here is the command for data types: `@deftp CATEGORY NAME ATTRIBUTES...' The `@deftp' command is the generic definition command for data types. The command is written at the beginning of a line and is followed on the same line by the category, by the name of the type (which is a word like `int' or `float'), and then by names of attributes of objects of that type. Thus, you could use this command for describing `int' or `float', in which case you could use `data type' as the category. (A data type is a category of certain objects for purposes of deciding which operations can be performed on them.) In Lisp, for example, "pair" names a particular data type, and an object of that type has two slots called the CAR and the CDR. Here is how you would write the first line of a definition of `pair'. @deftp {Data type} pair car cdr ... @end deftp The template is: @deftp CATEGORY NAME-OF-TYPE ATTRIBUTES... BODY-OF-DEFINITION @end deftp `@deftp' creates an entry in the index of data types. g of a line and./info/texinfo-8 644 0 0 140332 7442531461 6712 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Def Cmd Conventions, Next: Sample Function Definition, Prev: Def Cmds in Detail, Up: Definition Commands Conventions for Writing Definitions =================================== When you write a definition using `@deffn', `@defun', or one of the other definition commands, please take care to use arguments that indicate the meaning, as with the COUNT argument to the `forward-word' function. Also, if the name of an argument contains the name of a type, such as INTEGER, take care that the argument actually is of that type.  File: texinfo, Node: Sample Function Definition, Prev: Def Cmd Conventions, Up: Definition Commands A Sample Function Definition ============================ A function definition uses the `@defun' and `@end defun' commands. The name of the function follows immediately after the `@defun' command and it is followed, on the same line, by the parameter list. Here is a definition from *Note Calling Functions: (elisp)Calling Functions. - Function: apply function &rest arguments `apply' calls FUNCTION with ARGUMENTS, just like `funcall' but with one difference: the last of ARGUMENTS is a list of arguments to give to FUNCTION, rather than a single argument. We also say that this list is "appended" to the other arguments. `apply' returns the result of calling FUNCTION. As with `funcall', FUNCTION must either be a Lisp function or a primitive function; special forms and macros do not make sense in `apply'. (setq f 'list) => list (apply f 'x 'y 'z) error--> Wrong type argument: listp, z (apply '+ 1 2 '(3 4)) => 10 (apply '+ '(1 2 3 4)) => 10 (apply 'append '((a b c) nil (x y z) nil)) => (a b c x y z) An interesting example of using `apply' is found in the description of `mapcar'. In the Texinfo source file, this example looks like this: @defun apply function &rest arguments @code{apply} calls @var{function} with @var{arguments}, just like @code{funcall} but with one difference: the last of @var{arguments} is a list of arguments to give to @var{function}, rather than a single argument. We also say that this list is @dfn{appended} to the other arguments. @code{apply} returns the result of calling @var{function}. As with @code{funcall}, @var{function} must either be a Lisp function or a primitive function; special forms and macros do not make sense in @code{apply}. @example (setq f 'list) @result{} list (apply f 'x 'y 'z) @error{} Wrong type argument: listp, z (apply '+ 1 2 '(3 4)) @result{} 10 (apply '+ '(1 2 3 4)) @result{} 10 (apply 'append '((a b c) nil (x y z) nil)) @result{} (a b c x y z) @end example An interesting example of using @code{apply} is found in the description of @code{mapcar}. @end defun In this manual, this function is listed in the Command and Variable Index under `apply'. Ordinary variables and user options are described using a format like that for functions except that variables do not take arguments.  File: texinfo, Node: Conditionals, Next: Internationalization, Prev: Definition Commands, Up: Top Conditionally Visible Text ************************** Sometimes it is good to use different text for different output formats. For example, you can use the "conditional commands" to specify different text for the printed manual and the Info output. Conditional commands may not be nested. The conditional commands comprise the following categories. * Commands for HTML, Info, or TeX. * Commands for not HTML, Info, or TeX. * Raw TeX or HTML commands. * Substituting text for all formats, and testing if a flag is set or clear. * Menu: * Conditional Commands:: Specifying text for HTML, Info, or TeX. * Conditional Not Commands:: Specifying text for not HTML, Info, or TeX. * Raw Formatter Commands:: Using raw TeX or HTML commands. * set clear value:: Designating which text to format (for all output formats); and how to set a flag to a string that you can insert.  File: texinfo, Node: Conditional Commands, Next: Conditional Not Commands, Up: Conditionals Conditional Commands ==================== `@ifinfo' begins segments of text that should be ignored by TeX when it typesets the printed manual. The segment of text appears only in the Info file. The `@ifinfo' command should appear on a line by itself; end the Info-only text with a line containing `@end ifinfo' by itself. At the beginning of a Texinfo file, the Info permissions are contained within a region marked by `@ifinfo' and `@end ifinfo'. (*Note Info Summary and Permissions::.) The `@iftex' and `@end iftex' commands are similar to the `@ifinfo' and `@end ifinfo' commands, except that they specify text that will appear in the printed manual but not in the Info file. Likewise for `@ifhtml' and `@end ifhtml', which specify text to appear only in HTML output. For example, @iftex This text will appear only in the printed manual. @end iftex @ifinfo However, this text will appear only in Info. @end ifinfo @ifhtml And this text will only appear in HTML. @end ifhtml The preceding example produces the following line: However, this text will appear only in Info. Notice that you only see one of the input lines, depending on which version of the manual you are reading.  File: texinfo, Node: Conditional Not Commands, Next: Raw Formatter Commands, Prev: Conditional Commands, Up: Conditionals Conditional Not Commands ======================== You can specify text to be included in any output format _other_ than some given one with the `@ifnot...' commands: @ifnothtml ... @end ifnothtml @ifnotinfo ... @end ifnotinfo @ifnottex ... @end ifnottex (The `@ifnot...' command and the `@end' command must actually appear on lines by themselves.) If the output file is not being made for the given format, the region is included. Otherwise, it is ignored. The regions delimited by these commands are ordinary Texinfo source as with `@iftex', not raw formatter source as with `@tex' (*note Raw Formatter Commands::).  File: texinfo, Node: Raw Formatter Commands, Next: set clear value, Prev: Conditional Not Commands, Up: Conditionals Raw Formatter Commands ====================== Inside a region delineated by `@iftex' and `@end iftex', you can embed some raw TeX commands. Info will ignore these commands since they are only in that part of the file which is seen by TeX. You can write the TeX commands as you would write them in a normal TeX file, except that you must replace the `\' used by TeX with an `@'. For example, in the `@titlepage' section of a Texinfo file, you can use the TeX command `@vskip' to format the copyright page. (The `@titlepage' command causes Info to ignore the region automatically, as it does with the `@iftex' command.) However, many features of plain TeX will not work, as they are overridden by Texinfo features. You can enter plain TeX completely, and use `\' in the TeX commands, by delineating a region with the `@tex' and `@end tex' commands. (The `@tex' command also causes Info to ignore the region, like the `@iftex' command.) The sole exception is that the `@' character still introduces a command, so that `@end tex' can be recognized properly. For example, here is a mathematical expression written in plain TeX: @tex $$ \chi^2 = \sum_{i=1}^N \left (y_i - (a + b x_i) \over \sigma_i\right)^2 $$ @end tex The output of this example will appear only in a printed manual. If you are reading this in Info, you will not see the equation that appears in the printed manual. Analogously, you can use `@ifhtml ... @end ifhtml' to delimit a region to be included in HTML output only, and `@html ... @end html' for a region of raw HTML (again, except that `@' is still the escape character, so the `@end' command can be recognized.)  File: texinfo, Node: set clear value, Prev: Raw Formatter Commands, Up: Conditionals `@set', `@clear', and `@value' ============================== You can direct the Texinfo formatting commands to format or ignore parts of a Texinfo file with the `@set', `@clear', `@ifset', and `@ifclear' commands. Brief descriptions: `@set FLAG [VALUE]' Set the variable FLAG, to the optional VALUE if specifed. `@clear FLAG' Undefine the variable FLAG, whether or not it was previously defined. `@ifset FLAG' If FLAG is set, text through the next `@end ifset' command is formatted. If FLAG is clear, text through the following `@end ifset' command is ignored. `@ifclear FLAG' If FLAG is set, text through the next `@end ifclear' command is ignored. If FLAG is clear, text through the following `@end ifclear' command is formatted. * Menu: * set value:: Expand a flag variable to a string. * ifset ifclear:: Format a region if a flag is set. * value Example:: An easy way to update edition information.  File: texinfo, Node: set value, Next: ifset ifclear, Up: set clear value `@set' and `@value' ------------------- You use the `@set' command to specify a value for a flag, which is later expanded by the `@value' command. A "flag" is an identifier. In general, it is best to use only letters and numerals in a flag name, not `-' or `_'--they will work in some contexts, but not all, due to limitations in TeX. The value is the remainder of the input line, and can contain anything. Write the `@set' command like this: @set foo This is a string. This sets the value of the flag `foo' to "This is a string.". The Texinfo formatters then replace an `@value{FLAG}' command with the string to which FLAG is set. Thus, when `foo' is set as shown above, the Texinfo formatters convert this: @value{foo} to this: This is a string. You can write an `@value' command within a paragraph; but you must write an `@set' command on a line of its own. If you write the `@set' command like this: @set foo without specifying a string, the value of `foo' is the empty string. If you clear a previously set flag with `@clear FLAG', a subsequent `@value{flag}' command will report an error. For example, if you set `foo' as follows: @set how-much very, very, very then the formatters transform It is a @value{how-much} wet day. into It is a very, very, very wet day. If you write @clear how-much then the formatters transform It is a @value{how-much} wet day. into It is a {No value for "how-much"} wet day.  File: texinfo, Node: ifset ifclear, Next: value Example, Prev: set value, Up: set clear value `@ifset' and `@ifclear' ----------------------- When a FLAG is set, the Texinfo formatting commands format text between subsequent pairs of `@ifset FLAG' and `@end ifset' commands. When the FLAG is cleared, the Texinfo formatting commands do _not_ format the text. `@ifclear' operates analogously. Write the conditionally formatted text between `@ifset FLAG' and `@end ifset' commands, like this: @ifset FLAG CONDITIONAL-TEXT @end ifset For example, you can create one document that has two variants, such as a manual for a `large' and `small' model: You can use this machine to dig up shrubs without hurting them. @set large @ifset large It can also dig up fully grown trees. @end ifset Remember to replant promptly ... In the example, the formatting commands will format the text between `@ifset large' and `@end ifset' because the `large' flag is set. When FLAG is cleared, the Texinfo formatting commands do _not_ format the text between `@ifset FLAG' and `@end ifset'; that text is ignored and does not appear in either printed or Info output. For example, if you clear the flag of the preceding example by writing an `@clear large' command after the `@set large' command (but before the conditional text), then the Texinfo formatting commands ignore the text between the `@ifset large' and `@end ifset' commands. In the formatted output, that text does not appear; in both printed and Info output, you see only the lines that say, "You can use this machine to dig up shrubs without hurting them. Remember to replant promptly ...". If a flag is cleared with an `@clear FLAG' command, then the formatting commands format text between subsequent pairs of `@ifclear' and `@end ifclear' commands. But if the flag is set with `@set FLAG', then the formatting commands do _not_ format text between an `@ifclear' and an `@end ifclear' command; rather, they ignore that text. An `@ifclear' command looks like this: @ifclear FLAG  File: texinfo, Node: value Example, Prev: ifset ifclear, Up: set clear value `@value' Example ---------------- You can use the `@value' command to minimize the number of places you need to change when you record an update to a manual. Here is how it is done in `The GNU Make Manual': 1. Set the flags: @set EDITION 0.35 Beta @set VERSION 3.63 Beta @set UPDATED 14 August 1992 @set UPDATE-MONTH August 1992 2. Write text for the first `@ifinfo' section, for people reading the Texinfo file: This is Edition @value{EDITION}, last updated @value{UPDATED}, of @cite{The GNU Make Manual}, for @code{make}, version @value{VERSION}. 3. Write text for the title page, for people reading the printed manual: @title GNU Make @subtitle A Program for Directing Recompilation @subtitle Edition @value{EDITION}, ... @subtitle @value{UPDATE-MONTH} (On a printed cover, a date listing the month and the year looks less fussy than a date listing the day as well as the month and year.) 4. Write text for the Top node, for people reading the Info file: This is Edition @value{EDITION} of the @cite{GNU Make Manual}, last updated @value{UPDATED} for @code{make} Version @value{VERSION}. After you format the manual, the text in the first `@ifinfo' section looks like this: This is Edition 0.35 Beta, last updated 14 August 1992, of `The GNU Make Manual', for `make', Version 3.63 Beta. When you update the manual, change only the values of the flags; you do not need to edit the three sections.  File: texinfo, Node: Internationalization, Next: Defining New Texinfo Commands, Prev: Conditionals, Up: Top Internationalization ******************** Texinfo has some support for writing in languages other than English, although this area still needs considerable work. For a list of the various accented and special characters Texinfo supports, see *Note Inserting Accents::. * Menu: * documentlanguage:: Declaring the current language. * documentencoding:: Declaring the input encoding.  File: texinfo, Node: documentlanguage, Next: documentencoding, Up: Internationalization `@documentlanguage CC': Set the Document Language ================================================= The `@documentlanguage' command declares the current document language. Write it on a line by itself, with a two-letter ISO-639 language code following (list is included below). If you have a multilingual document, the intent is to be able to use this command multiple times, to declare each language change. If the command is not used at all, the default is `en' for English. At present, this command is ignored in Info and HTML output. For TeX, it causes the file `txi-CC.tex' to be read (if it exists). Such a file appropriately redefines the various English words used in TeX output, such as `Chapter', `See', and so on. It would be good if this command also changed TeX's ideas of the current hyphenation patterns (via the TeX primitive `\language'), but this is unfortunately not currently implemented. Hereare the valid language codes, from ISO-639. `aa' Afar `ab' Abkhazian `af' Afrikaans `am' Amharic `ar' Arabic `as' Assamese `ay' Aymara `az' Azerbaijani `ba' Bashkir `be' Byelorussian `bg' Bulgarian `bh' Bihari `bi' Bislama `bn' Bengali; Bangla `bo' Tibetan `br' Breton `ca' Catalan `co' Corsican `cs' Czech `cy' Welsh `da' Danish `de' German `dz' Bhutani `el' Greek `en' English `eo' Esperanto `es' Spanish `et' Estonian `eu' Basque `fa' Persian `fi' Finnish `fj' Fiji `fo' Faroese `fr' French `fy' Frisian `ga' Irish `gd' Scots Gaelic `gl' Galician `gn' Guarani `gu' Gujarati `ha' Hausa `he' Hebrew `hi' Hindi `hr' Croatian `hu' Hungarian `hy' Armenian `ia' Interlingua `id' Indonesian `ie' Interlingue `ik' Inupiak `is' Icelandic `it' Italian `iu' Inuktitut `ja' Japanese `jw' Javanese `ka' Georgian `kk' Kazakh `kl' Greenlandic `km' Cambodian `kn' Kannada `ks' Kashmiri `ko' Korean `ku' Kurdish `ky' Kirghiz `la' Latin `ln' Lingala `lt' Lithuanian `lo' Laothian `lv' Latvian, Lettish `mg' Malagasy `mi' Maori `mk' Macedonian `ml' Malayalam `mn' Mongolian `mo' Moldavian `mr' Marathi `ms' Malay `mt' Maltese `my' Burmese `na' Nauru `ne' Nepali `nl' Dutch `no' Norwegian `oc' Occitan `om' (Afan) Oromo `or' Oriya `pa' Punjabi `pl' Polish `ps' Pashto, Pushto `pt' Portuguese `qu' Quechua `rm' Rhaeto-Romance `rn' Kirundi `ro' Romanian `ru' Russian `rw' Kinyarwanda `sa' Sanskrit `sd' Sindhi `sg' Sangro `sh' Serbo-Croatian `si' Sinhalese `sk' Slovak `sl' Slovenian `sm' Samoan `sn' Shona `so' Somali `sq' Albanian `sr' Serbian `ss' Siswati `st' Sesotho `su' Sundanese `sv' Swedish `sw' Swahili `ta' Tamil `te' Telugu `tg' Tajik `th' Thai `ti' Tigrinya `tk' Turkmen `tl' Tagalog `tn' Setswana `to' Tonga `tr' Turkish `ts' Tsonga `tt' Tatar `tw' Twi `ug' Uighur `uk' Ukrainian `ur' Urdu `uz' Uzbek `vi' Vietnamese `vo' Volapuk `wo' Wolof `xh' Xhosa `yi' Yiddish `yo' Yoruba `za' Zhuang `zh' Chinese `zu' Zulu  File: texinfo, Node: documentencoding, Prev: documentlanguage, Up: Internationalization `@documentencoding ENC': Set Input Encoding =========================================== The `@documentencoding' command declares the input document encoding. Write it on a line by itself, with a valid encoding specification following, such as `ISO-8859-1'. At present, this is used only in HTML output from `makeinfo'. If a document encoding ENC is specified, it is used in a `' tag included in the `' of the output:  File: texinfo, Node: Defining New Texinfo Commands, Next: Hardcopy, Prev: Internationalization, Up: Top Defining New Texinfo Commands ***************************** Texinfo provides several ways to define new commands: * A Texinfo "macro" allows you to define a new Texinfo command as any sequence of text and/or existing commands (including other macros). The macro can have any number of "parameters"--text you supply each time you use the macro. Incidentally, these macros have nothing to do with the `@defmac' command, which is for documenting macros in the subject of the manual (*note Def Cmd Template::). * `@alias' is a convenient way to define a new name for an existing command. * `@definfoenclose' allows you to define new commands with customized output in the Info file. * Menu: * Defining Macros:: Defining and undefining new commands. * Invoking Macros:: Using a macro, once you've defined it. * Macro Details:: Beyond basic macro usage. * alias:: Command aliases. * definfoenclose:: Customized highlighting.  File: texinfo, Node: Defining Macros, Next: Invoking Macros, Up: Defining New Texinfo Commands Defining Macros =============== You use the Texinfo `@macro' command to define a macro, like this: @macro MACRONAME{PARAM1, PARAM2, ...} TEXT ... \PARAM1\ ... @end macro The "parameters" PARAM1, PARAM2, ... correspond to arguments supplied when the macro is subsequently used in the document (described in the next section). For a macro to work with TeX, MACRONAME must consist entirely of letters: no digits, hyphens, underscores, or other special characters. If a macro needs no parameters, you can define it either with an empty list (`@macro foo {}') or with no braces at all (`@macro foo'). The definition or "body" of the macro can contain most Texinfo commands, including previously-defined macros. Not-yet-defined macro invocations are not allowed; thus, it is not possible to have mutually recursive Texinfo macros. Also, a macro definition that defines another macro does not work in TeX due to limitations in the design of `@macro'. In the macro body, instances of a parameter name surrounded by backslashes, as in `\PARAM1\' in the example above, are replaced by the corresponding argument from the macro invocation. You can use parameter names any number of times in the body, including zero. To get a single `\' in the macro expansion, use `\\'. Any other use of `\' in the body yields a warning. The newlines after the `@macro' line and before the `@end macro' line are ignored, that is, not included in the macro body. All other whitespace is treated according to the usual Texinfo rules. To allow a macro to be used recursively, that is, in an argument to a call to itself, you must define it with `@rmacro', like this: @rmacro rmac {arg} a\arg\b @end rmacro ... @rmac{1@rmac{text}2} This produces the output `a1atextb2b'. With `@macro' instead of `@rmacro', an error message is given. You can undefine a macro FOO with `@unmacro FOO'. It is not an error to undefine a macro that is already undefined. For example: @unmacro foo  File: texinfo, Node: Invoking Macros, Next: Macro Details, Prev: Defining Macros, Up: Defining New Texinfo Commands Invoking Macros =============== After a macro is defined (see the previous section), you can use ("invoke") it in your document like this: @MACRONAME {ARG1, ARG2, ...} and the result will be just as if you typed the body of MACRONAME at that spot. For example: @macro foo {p, q} Together: \p\ & \q\. @end macro @foo{a, b} produces: Together: a & b. Thus, the arguments and parameters are separated by commas and delimited by braces; any whitespace after (but not before) a comma is ignored. The braces are required in the invocation (but not the definition), even when the macro takes no arguments, consistent with all other Texinfo commands. For example: @macro argless {} No arguments here. @end macro @argless{} produces: No arguments here. To insert a comma, brace, or backslash in an argument, prepend a backslash, as in @MACNAME {\\\{\}\,} which will pass the (almost certainly error-producing) argument `\{},' to MACNAME. However, commas in parameters, even if escaped by a backslash, might cause trouble in TeX. If the macro is defined to take a single argument, and is invoked without any braces, the entire rest of the line after the macro name is supplied as the argument. For example: @macro bar {p} Twice: \p\ & \p\. @end macro @bar aah produces: Twice: aah & aah. If the macro is defined to take a single argument, and is invoked with braces, the braced text is passed as the argument, regardless of commas. For example: @macro bar {p} Twice: \p\ & \p\. @end macro @bar{a,b} produces: Twice: a,b & a,b.  File: texinfo, Node: Macro Details, Next: alias, Prev: Invoking Macros, Up: Defining New Texinfo Commands Macro Details ============= Due to unavoidable disparities in the TeX and `makeinfo' implementations, Texinfo macros have the following limitations. * All macros are expanded inside at least one TeX group. This means that `@set' and other such commands will have no effect inside a macro. * Macros containing a command which must be on a line by itself, such as a conditional, cannot be invoked in the middle of a line. * Commas in macro arguments, even if escaped by a backslash, don't always work. * The TeX implementation cannot construct macros that define macros in the natural way. To do this, you must use conditionals and raw TeX. For example: @ifinfo @macro ctor {name, arg} @macro \name\ something involving \arg\ somehow @end macro @end macro @end ifinfo @tex \gdef\ctor#1{\ctorx#1,} \gdef\ctorx#1,#2,{\def#1{something involving #2 somehow}} @end tex * It is best to avoid comments inside macro definitions. If some macro feature causes errors when producing the printed version of a manual, try expanding the macros with `makeinfo' by invoking `texi2dvi' with the `-e' option; see *Note Format with texi2dvi::.  File: texinfo, Node: alias, Next: definfoenclose, Prev: Macro Details, Up: Defining New Texinfo Commands `@alias NEW=EXISTING' ===================== The `@alias' command defines a new command to be just like an existing one. This is useful for defining additional markup names, thus preserving semantic information in the input even though the output result may be the same. Write the `@alias' command on a line by itself, followed by the new command name, an equals sign, and the existing command name. Whitespace around the equals sign is ignored. Thus: @alias NEW = EXISTING For example, if your document contains citations for both books and some other media (movies, for example), you might like to define a macro `@moviecite{}' that does the same thing as an ordinary `@cite{}' but conveys the extra semantic information as well. You'd do this as follows: @alias moviecite = cite Macros do not always have the same effect due to vagaries of argument parsing. Also, aliases are much simpler to define than macros. So the command is not redundant. (It was also heavily used in the Jargon File!) Aliases must not be recursive, directly or indirectly.  File: texinfo, Node: definfoenclose, Prev: alias, Up: Defining New Texinfo Commands `definfoenclose': Customized Highlighting ========================================= A `@definfoenclose' command may be used to define a highlighting command for Info, but not for TeX. A command defined using `@definfoenclose' marks text by enclosing it in strings that precede and follow the text. You can use this to get closer control of your Info output. Presumably, if you define a command with `@definfoenclose' for Info, you will create a corresponding command for TeX, either in `texinfo.tex', `texinfo.cnf', or within an `@iftex' in your document. Write a `@definfoenclose' command on a line and follow it with three arguments separated by commas. The first argument to `@definfoenclose' is the @-command name (without the `@'); the second argument is the Info start delimiter string; and the third argument is the Info end delimiter string. The latter two arguments enclose the highlighted text in the Info file. A delimiter string may contain spaces. Neither the start nor end delimiter is required. If you do not want a start delimiter but do want an end delimiter, you must follow the command name with two commas in a row; otherwise, the Info formatting commands will naturally misinterpret the end delimiter string you intended as the start delimiter string. If you do a `@definfoenclose' on the name of a pre-defined macro (such as `@emph', `@strong', `@t', or `@i'), the enclosure definition will override the built-in definition. An enclosure command defined this way takes one argument in braces; this is intended for new markup commands (*note Marking Text::). For example, you can write: @definfoenclose phoo,//,\\ near the beginning of a Texinfo file to define `@phoo' as an Info formatting command that inserts `//' before and `\\' after the argument to `@phoo'. You can then write `@phoo{bar}' wherever you want `//bar\\' highlighted in Info. Also, for TeX formatting, you could write @iftex @global@let@phoo=@i @end iftex to define `@phoo' as a command that causes TeX to typeset the argument to `@phoo' in italics. Each definition applies to its own formatter: one for TeX, the other for `texinfo-format-buffer' or `texinfo-format-region'. The `@definfoenclose' command need not be within `@ifinfo', but the raw TeX commands do need to be in `@iftex'. Here is another example: write @definfoenclose headword, , : near the beginning of the file, to define `@headword' as an Info formatting command that inserts nothing before and a colon after the argument to `@headword'. `@definfoenclose' definitions must not be recursive, directly or indirectly.  File: texinfo, Node: Hardcopy, Next: Creating and Installing Info Files, Prev: Defining New Texinfo Commands, Up: Top Formatting and Printing Hardcopy ******************************** There are three major shell commands for making a printed manual from a Texinfo file: one for converting the Texinfo file into a file that will be printed, a second for sorting indices, and a third for printing the formatted document. When you use the shell commands, you can either work directly in the operating system shell or work within a shell inside GNU Emacs. If you are using GNU Emacs, you can use commands provided by Texinfo mode instead of shell commands. In addition to the three commands to format a file, sort the indices, and print the result, Texinfo mode offers key bindings for commands to recenter the output buffer, show the print queue, and delete a job from the print queue. * Menu: * Use TeX:: Use TeX to format for hardcopy. * Format with tex/texindex:: How to format with explicit shell commands. * Format with texi2dvi:: A simpler way to format. * Print with lpr:: How to print. * Within Emacs:: How to format and print from an Emacs shell. * Texinfo Mode Printing:: How to format and print in Texinfo mode. * Compile-Command:: How to print using Emacs's compile command. * Requirements Summary:: TeX formatting requirements summary. * Preparing for TeX:: What to do before you use TeX. * Overfull hboxes:: What are and what to do with overfull hboxes. * smallbook:: How to print small format books and manuals. * A4 Paper:: How to print on A4 or A5 paper. * pagesizes:: How to print with customized page sizes. * Cropmarks and Magnification:: How to print marks to indicate the size of pages and how to print scaled up output. * PDF Output:: Portable Document Format output.  File: texinfo, Node: Use TeX, Next: Format with tex/texindex, Up: Hardcopy Use TeX ======= The typesetting program called TeX is used for formatting a Texinfo file. TeX is a very powerful typesetting program and, if used correctly, does an exceptionally good job. (*Note How to Obtain TeX: Obtaining TeX, for information on how to obtain TeX.) The standalone `makeinfo' program and Emacs functions `texinfo-format-region' and `texinfo-format-buffer' commands read the very same @-commands in the Texinfo file as does TeX, but process them differently to make an Info file (*note Creating an Info File::).  File: texinfo, Node: Format with tex/texindex, Next: Format with texi2dvi, Prev: Use TeX, Up: Hardcopy Format with `tex' and `texindex' ================================ Format the Texinfo file with the shell command `tex' followed by the name of the Texinfo file. For example: tex foo.texi TeX will produce a "DVI file" as well as several auxiliary files containing information for indices, cross references, etc. The DVI file (for "DeVice Independent" file) can be printed on virtually any device (see the following sections). The `tex' formatting command itself does not sort the indices; it writes an output file of unsorted index data. (The `texi2dvi' command automatically generates indices; *note Format with `texi2dvi': Format with texi2dvi..) To generate a printed index after running the `tex' command, you first need a sorted index to work from. The `texindex' command sorts indices. (The source file `texindex.c' comes as part of the standard Texinfo distribution, among other places.) The `tex' formatting command outputs unsorted index files under names that obey a standard convention: the name of your main input file with any `.tex' (or similar, *note tex invocation: (web2c)tex invocation.) extension removed, followed by the two letter names of indices. For example, the raw index output files for the input file `foo.texinfo' would be `foo.cp', `foo.vr', `foo.fn', `foo.tp', `foo.pg' and `foo.ky'. Those are exactly the arguments to give to `texindex'. Instead of specifying all the unsorted index file names explicitly, you can use `??' as shell wildcards and give the command in this form: texindex foo.?? This command will run `texindex' on all the unsorted index files, including any that you have defined yourself using `@defindex' or `@defcodeindex'. (You may execute `texindex foo.??' even if there are similarly named files with two letter extensions that are not index files, such as `foo.el'. The `texindex' command reports but otherwise ignores such files.) For each file specified, `texindex' generates a sorted index file whose name is made by appending `s' to the input file name. The `@printindex' command looks for a file with that name (*note Printing Indices & Menus::). `texindex' does not alter the raw index output file. After you have sorted the indices, you need to rerun the `tex' formatting command on the Texinfo file. This regenerates the DVI file, this time with up-to-date index entries. Finally, you may need to run `tex' one more time, to get the page numbers in the cross-references correct. To summarize, this is a five step process: 1. Run `tex' on your Texinfo file. This generates a DVI file (with undefined cross-references and no indices), and the raw index files (with two letter extensions). 2. Run `texindex' on the raw index files. This creates the corresponding sorted index files (with three letter extensions). 3. Run `tex' again on your Texinfo file. This regenerates the DVI file, this time with indices and defined cross-references, but with page numbers for the cross-references from last time, generally incorrect. 4. Sort the indices again, with `texindex'. 5. Run `tex' one last time. This time the correct page numbers are written for the cross-references. Alternatively, it's a one-step process: run `texi2dvi' (*note Format with texi2dvi::). You need not run `texindex' each time after you run `tex'. If you do not, on the next run, the `tex' formatting command will use whatever sorted index files happen to exist from the previous use of `texindex'. This is usually ok while you are debugging. Sometimes you may wish to print a document while you know it is incomplete, or to print just one chapter of a document. In that case, the usual auxiliary files that TeX creates and warnings TeX gives when cross-references are not satisfied are just nuisances. You can avoid them with the `@novalidate' command, which you must give _before_ the `@setfilename' command (*note `@setfilename': setfilename.). Thus, the beginning of your file would look approximately like this: \input texinfo @novalidate @setfilename myfile.info ... `@novalidate' also turns off validation in `makeinfo', just like its `--no-validate' option (*note Pointer Validation::).  File: texinfo, Node: Format with texi2dvi, Next: Print with lpr, Prev: Format with tex/texindex, Up: Hardcopy Format with `texi2dvi' ====================== The `texi2dvi' command automatically runs both `tex' and `texindex' as many times as necessary to produce a DVI file with sorted indices and all cross-references resolved. It simplifies the `tex'--`texindex'--`tex'--`tex' sequence described in the previous section. To run `texi2dvi' on an input file `foo.texi', do this (where `prompt$ ' is your shell prompt): prompt$ texi2dvi foo.texi As shown in this example, the input filenames to `texi2dvi' must include any extension (`.texi', `.texinfo', etc.). Under MS-DOS and perhaps in other circumstances, you may need to run `sh texi2dvi foo.texi' instead of relying on the operating system to invoke the shell on the `texi2dvi' script. Perhaps the most useful option to `texi2dvi' is `--texinfo=CMD'. This inserts CMD on a line by itself after the `@setfilename' in a temporary copy of the input file before running TeX. With this, you can specify different printing formats, such as `@smallbook' (*note smallbook::), `@afourpaper' (*note A4 Paper::), or `@pagesizes' (*note pagesizes::), without actually changing the document source. (You can also do this on a site-wide basis with `texinfo.cnf'; *note Preparing for TeX: Preparing for TeX.). For a list of other options, run `texi2dvi --help'.  File: texinfo, Node: Print with lpr, Next: Within Emacs, Prev: Format with texi2dvi, Up: Hardcopy Shell Print Using `lpr -d' ========================== The precise command to print a DVI file depends on your system installation. Two common ones are `dvips foo.dvi -o' and `lpr -d foo.dvi'. For example, the following commands will (perhaps) suffice to sort the indices, format, and print the `Bison Manual': tex bison.texinfo texindex bison.?? tex bison.texinfo lpr -d bison.dvi (Remember that the shell commands may be different at your site; but these are commonly used versions.) Using the `texi2dvi' shell script (see the previous section): texi2dvi bison.texinfo lpr -d bison.dvi # or perhaps dvips bison.dvi -o `lpr' is a standard program on Unix systems, but it is usually absent on MS-DOS/MS-Windows. Some network packages come with a program named `lpr', but these are usually limited to sending files to a print server over the network, and generally don't support the `-d' option. If you are unfortunate enough to work on one of these systems, you have several alternative ways of printing DVI files: * Find and install a Unix-like `lpr' program, or its clone. If you can do that, you will be able to print DVI files just like described above. * Send the DVI files to a network printer queue for DVI files. Some network printers have special queues for printing DVI files. You should be able to set up your network software to send files to that queue. In some cases, the version of `lpr' which comes with your network software will have a special option to send a file to specific queues, like this: lpr -Qdvi -hprint.server.domain bison.dvi * Convert the DVI file to a Postscript or PCL file and send it to your local printer. *Note dvips invocation: (dvips)dvips invocation, and the man pages for `dvilj', for detailed description of these tools. Once the DVI file is converted to the format your local printer understands directly, just send it to the appropriate port, usually `PRN'.  File: texinfo, Node: Within Emacs, Next: Texinfo Mode Printing, Prev: Print with lpr, Up: Hardcopy From an Emacs Shell =================== You can give formatting and printing commands from a shell within GNU Emacs. To create a shell within Emacs, type `M-x shell'. In this shell, you can format and print the document. *Note Format and Print Hardcopy: Hardcopy, for details. You can switch to and from the shell buffer while `tex' is running and do other editing. If you are formatting a long document on a slow machine, this can be very convenient. You can also use `texi2dvi' from an Emacs shell. For example, here is how to use `texi2dvi' to format and print `Using and Porting GNU CC' from a shell within Emacs: texi2dvi gcc.texinfo lpr -d gcc.dvi *Note Texinfo Mode Printing::, for more information about formatting and printing in Texinfo mode.  File: texinfo, Node: Texinfo Mode Printing, Next: Compile-Command, Prev: Within Emacs, Up: Hardcopy Formatting and Printing in Texinfo Mode ======================================= Texinfo mode provides several predefined key commands for TeX formatting and printing. These include commands for sorting indices, looking at the printer queue, killing the formatting job, and recentering the display of the buffer in which the operations occur. `C-c C-t C-b' `M-x texinfo-tex-buffer' Run `texi2dvi' on the current buffer. `C-c C-t C-r' `M-x texinfo-tex-region' Run TeX on the current region. `C-c C-t C-i' `M-x texinfo-texindex' Sort the indices of a Texinfo file formatted with `texinfo-tex-region'. `C-c C-t C-p' `M-x texinfo-tex-print' Print a DVI file that was made with `texinfo-tex-region' or `texinfo-tex-buffer'. `C-c C-t C-q' `M-x tex-show-print-queue' Show the print queue. `C-c C-t C-d' `M-x texinfo-delete-from-print-queue' Delete a job from the print queue; you will be prompted for the job number shown by a preceding `C-c C-t C-q' command (`texinfo-show-tex-print-queue'). `C-c C-t C-k' `M-x tex-kill-job' Kill the currently running TeX job started by either `texinfo-tex-region' or `texinfo-tex-buffer', or any other process running in the Texinfo shell buffer. `C-c C-t C-x' `M-x texinfo-quit-job' Quit a TeX formatting job that has stopped because of an error by sending an to it. When you do this, TeX preserves a record of what it did in a `.log' file. `C-c C-t C-l' `M-x tex-recenter-output-buffer' Redisplay the shell buffer in which the TeX printing and formatting commands are run to show its most recent output. Thus, the usual sequence of commands for formatting a buffer is as follows (with comments to the right): C-c C-t C-b Run `texi2dvi' on the buffer. C-c C-t C-p Print the DVI file. C-c C-t C-q Display the printer queue. The Texinfo mode TeX formatting commands start a subshell in Emacs called the `*tex-shell*'. The `texinfo-tex-command', `texinfo-texindex-command', and `tex-dvi-print-command' commands are all run in this shell. You can watch the commands operate in the `*tex-shell*' buffer, and you can switch to and from and use the `*tex-shell*' buffer as you would any other shell buffer. The formatting and print commands depend on the values of several variables. The default values are: Variable Default value texinfo-texi2dvi-command "texi2dvi" texinfo-tex-command "tex" texinfo-texindex-command "texindex" texinfo-delete-from-print-queue-command "lprm" texinfo-tex-trailer "@bye" tex-start-of-header "%**start" tex-end-of-header "%**end" tex-dvi-print-command "lpr -d" tex-show-queue-command "lpq" You can change the values of these variables with the `M-x edit-options' command (*note Editing Variable Values: (emacs)Edit Options.), with the `M-x set-variable' command (*note Examining and Setting Variables: (emacs)Examining.), or with your `.emacs' initialization file (*note Init File: (emacs)Init File.). Beginning with version 20, GNU Emacs offers a user-friendly interface, called "Customize", for changing values of user-definable variables. *Note Easy Customization Interface: (emacs)Easy Customization, for more details about this. The Texinfo variables can be found in the `Development/Docs/Texinfo' group, once you invoke the `M-x customize' command.  File: texinfo, Node: Compile-Command, Next: Requirements Summary, Prev: Texinfo Mode Printing, Up: Hardcopy Using the Local Variables List ============================== Yet another way to apply the TeX formatting command to a Texinfo file is to put that command in a "local variables list" at the end of the Texinfo file. You can then specify the `tex' or `texi2dvi' commands as a `compile-command' and have Emacs run it by typing `M-x compile'. This creates a special shell called the `*compilation*' buffer in which Emacs runs the compile command. For example, at the end of the `gdb.texinfo' file, after the `@bye', you could put the following: Local Variables: compile-command: "texi2dvi gdb.texinfo" End: This technique is most often used by programmers who also compile programs this way; see *Note Compilation: (emacs)Compilation.  File: texinfo, Node: Requirements Summary, Next: Preparing for TeX, Prev: Compile-Command, Up: Hardcopy TeX Formatting Requirements Summary =================================== Every Texinfo file that is to be input to TeX must begin with a `\input' command and must contain an `@setfilename' command: \input texinfo @setfilename ARG-NOT-USED-BY-TEX The first command instructs TeX to load the macros it needs to process a Texinfo file and the second command opens auxiliary files. Every Texinfo file must end with a line that terminates TeX's processing and forces out unfinished pages: @bye Strictly speaking, these lines are all a Texinfo file needs to be processed successfully by TeX. Usually, however, the beginning includes an `@settitle' command to define the title of the printed manual, an `@setchapternewpage' command, a title page, a copyright page, and permissions. Besides an `@bye', the end of a file usually includes indices and a table of contents. (And of course most manuals contain a body of text as well.) For more information, see: * *Note `@settitle': settitle * *Note `@setchapternewpage': setchapternewpage * *Note Page Headings: Headings * *Note Titlepage & Copyright Page:: * *Note Printing Indices & Menus:: * *Note Contents:: andard program on Unix systems, but it is usually absent on MS-DOS/MS-Windows. Some network packages come with a program named `lpr', but these are usually limited to sending files to a print server over the network, and generally don't support the `-d' option. If you are unfortunate enough ./info/texinfo-9 644 0 0 137772 7442531461 6731 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Preparing for TeX, Next: Overfull hboxes, Prev: Requirements Summary, Up: Hardcopy Preparing for TeX ================= TeX needs to know where to find the `texinfo.tex' file that the `\input texinfo' command on the first line reads. The `texinfo.tex' file tells TeX how to handle @-commands; it is included in all standard GNU distributions. Usually, the installer has put the `texinfo.tex' file in the default directory that contains TeX macros when GNU Texinfo, Emacs or other GNU software is installed. In this case, TeX will find the file and you do not need to do anything special. If this has not been done, you can put `texinfo.tex' in the current directory when you run TeX, and TeX will find it there. Also, you should install `epsf.tex', if it is not already installed from another distribution. More details are at the end of the description of the `@image' command (*note Images::). Likewise for `pdfcolor.tex', if it is not already installed and you use pdftex. Optionally, you may create an additional `texinfo.cnf', and install it as well. This file is read by TeX when the `@setfilename' command is executed (*note `@setfilename': setfilename.). You can put any commands you like there, according to local site-wide conventions. They will be read by TeX when processing any Texinfo document. For example, if `texinfo.cnf' contains the line `@afourpaper' (*note A4 Paper::), then all Texinfo documents will be processed with that page size in effect. If you have nothing to put in `texinfo.cnf', you do not need to create it. If neither of the above locations for these system files suffice for you, you can specify the directories explicitly. For `texinfo.tex', you can do this by writing the complete path for the file after the `\input' command. Another way, that works for both `texinfo.tex' and `texinfo.cnf' (and any other file TeX might read), is to set the `TEXINPUTS' environment variable in your `.cshrc' or `.profile' file. Which you use of `.cshrc' or `.profile' depends on whether you use a Bourne shell-compatible (`sh', `bash', `ksh', ...) or C shell-compatible (`csh', `tcsh') command interpreter. The latter read the `.cshrc' file for initialization information, and the former read `.profile'. In a `.cshrc' file, you could use the following `csh' command sequence: setenv TEXINPUTS .:/home/me/mylib:/usr/lib/tex/macros In a `.profile' file, you could use the following `sh' command sequence: TEXINPUTS=.:/home/me/mylib:/usr/lib/tex/macros export TEXINPUTS On MS-DOS/MS-Windows, you would say it like this(1) (*note Preparing for TeX-Footnote-1::): set TEXINPUTS=.;d:/home/me/mylib;c:/usr/lib/tex/macros It is customary for DOS/Windows users to put such commands in the `autoexec.bat' file, or in the Windows Registry. These settings would cause TeX to look for `\input' file first in the current directory, indicated by the `.', then in a hypothetical user's `me/mylib' directory, and finally in a system directory `/usr/lib/tex/macros'. Finally, you may wish to dump a `.fmt' file (*note Memory dumps: (web2c)Memory dumps.) so that TeX can load Texinfo faster. (The disadvantage is that then updating `texinfo.tex' requires redumping.) You can do this by running this command, assuming `epsf.tex' is findable by TeX: initex texinfo @dump (`dump' is a TeX primitive.) Then, move `texinfo.fmt' to wherever your `.fmt' files are found; typically, this will be in the subdirectory `web2c' of your TeX installation.  File: texinfo, Node: Preparing for TeX-Footnotes, Up: Preparing for TeX (1) Note the use of the `;' character, instead of `:', as directory separator on these systems.  File: texinfo, Node: Overfull hboxes, Next: smallbook, Prev: Preparing for TeX, Up: Hardcopy Overfull "hboxes" ================= TeX is sometimes unable to typeset a line without extending it into the right margin. This can occur when TeX comes upon what it interprets as a long word that it cannot hyphenate, such as an electronic mail network address or a very long title. When this happens, TeX prints an error message like this: Overfull @hbox (20.76302pt too wide) (In TeX, lines are in "horizontal boxes", hence the term, "hbox". `@hbox' is a TeX primitive not needed in the Texinfo language.) TeX also provides the line number in the Texinfo source file and the text of the offending line, which is marked at all the places that TeX considered hyphenation. *Note Catching Errors with TeX Formatting: Debugging with TeX, for more information about typesetting errors. If the Texinfo file has an overfull hbox, you can rewrite the sentence so the overfull hbox does not occur, or you can decide to leave it. A small excursion into the right margin often does not matter and may not even be noticeable. If you have many overfull boxes and/or an antipathy to rewriting, you can coerce TeX into greatly increasing the allowable interword spacing, thus (if you're lucky) avoiding many of the bad line breaks, like this: @tex \global\emergencystretch = .9\hsize @end tex (You should adjust the fraction as needed.) This huge value for `\emergencystretch' cannot be the default, since then the typeset output would generally be of noticeably lower quality; the default is `.15\hsize'. `\hsize' is the TeX dimension containing the current line width. For what overfull boxes you have, however, TeX will print a large, ugly, black rectangle beside the line that contains the overfull hbox unless told otherwise. This is so you will notice the location of the problem if you are correcting a draft. To prevent such a monstrosity from marring your final printout, write the following in the beginning of the Texinfo file on a line of its own, before the `@titlepage' command: @finalout  File: texinfo, Node: smallbook, Next: A4 Paper, Prev: Overfull hboxes, Up: Hardcopy Printing "Small" Books ====================== By default, TeX typesets pages for printing in an 8.5 by 11 inch format. However, you can direct TeX to typeset a document in a 7 by 9.25 inch format that is suitable for bound books by inserting the following command on a line by itself at the beginning of the Texinfo file, before the title page: @smallbook (Since many books are about 7 by 9.25 inches, this command might better have been called the `@regularbooksize' command, but it came to be called the `@smallbook' command by comparison to the 8.5 by 11 inch format.) If you write the `@smallbook' command between the start-of-header and end-of-header lines, the Texinfo mode TeX region formatting command, `texinfo-tex-region', will format the region in "small" book size (*note Start of Header::). *Note small::, for information about commands that make it easier to produce examples for a smaller manual. *Note Format with texi2dvi::, and *Note Preparing for TeX: Preparing for TeX, for other ways to format with `@smallbook' that do not require changing the source file.  File: texinfo, Node: A4 Paper, Next: pagesizes, Prev: smallbook, Up: Hardcopy Printing on A4 Paper ==================== You can tell TeX to format a document for printing on European size A4 paper (or A5) with the `@afourpaper' (or `@afivepaper') command. Write the command on a line by itself near the beginning of the Texinfo file, before the title page. For example, this is how you would write the header for this manual: \input texinfo @c -*-texinfo-*- @c %**start of header @setfilename texinfo @settitle Texinfo @afourpaper @c %**end of header *Note Format with texi2dvi::, and *Note Preparing for TeX: Preparing for TeX, for other ways to format for different paper sizes that do not require changing the source file. You may or may not prefer the formatting that results from the command `@afourlatex'. There's also `@afourwide' for A4 paper in wide format.  File: texinfo, Node: pagesizes, Next: Cropmarks and Magnification, Prev: A4 Paper, Up: Hardcopy `@pagesizes' [WIDTH][, HEIGHT]: Custom page sizes ================================================= You can explicitly specify the height and (optionally) width of the main text area on the page with the `@pagesizes' command. Write this on a line by itself near the beginning of the Texinfo file, before the title page. The height comes first, then the width if desired, separated by a comma. Examples: @pagesizes 200mm,150mm and @pagesizes 11.5in This would be reasonable for printing on B5-size paper. To emphasize, this command specifies the size of the _text area_, not the size of the paper (which is 250mm by 177mm for B5, 14in by 8.5in for legal). To make more elaborate changes, such as changing any of the page margins, you must define a new command in `texinfo.tex' (or `texinfo.cnf', *note Preparing for TeX: Preparing for TeX.). *Note Format with texi2dvi::, and *Note Preparing for TeX: Preparing for TeX, for other ways to specify `@pagesizes' that do not require changing the source file. `@pagesizes' is ignored by `makeinfo'.  File: texinfo, Node: Cropmarks and Magnification, Next: PDF Output, Prev: pagesizes, Up: Hardcopy Cropmarks and Magnification =========================== You can (attempt to) direct TeX to print cropmarks at the corners of pages with the `@cropmarks' command. Write the `@cropmarks' command on a line by itself between `@iftex' and `@end iftex' lines near the beginning of the Texinfo file, before the title page, like this: @iftex @cropmarks @end iftex This command is mainly for printers that typeset several pages on one sheet of film; but you can attempt to use it to mark the corners of a book set to 7 by 9.25 inches with the `@smallbook' command. (Printers will not produce cropmarks for regular sized output that is printed on regular sized paper.) Since different printing machines work in different ways, you should explore the use of this command with a spirit of adventure. You may have to redefine the command in `texinfo.tex'. You can attempt to direct TeX to typeset pages larger or smaller than usual with the `\mag' TeX command. Everything that is typeset is scaled proportionally larger or smaller. (`\mag' stands for "magnification".) This is _not_ a Texinfo @-command, but is a plain TeX command that is prefixed with a backslash. You have to write this command between `@tex' and `@end tex' (*note Raw Formatter Commands::). Follow the `\mag' command with an `=' and then a number that is 1000 times the magnification you desire. For example, to print pages at 1.2 normal size, write the following near the beginning of the Texinfo file, before the title page: @tex \mag=1200 @end tex With some printing technologies, you can print normal-sized copies that look better than usual by giving a larger-than-normal master to your print shop. They do the reduction, thus effectively increasing the resolution. Depending on your system, DVI files prepared with a nonstandard-`\mag' may not print or may print only with certain magnifications. Be prepared to experiment.  File: texinfo, Node: PDF Output, Prev: Cropmarks and Magnification, Up: Hardcopy PDF Output ========== You can generate a PDF output file from Texinfo source by using the `pdftex' program to process your file instead of plain `tex'. Just run `pdftex foo.texi' instead of `tex foo.texi', or give the `--pdf' option to `texi2dvi'. "PDF" stands for `Portable Document Format'. It was invented by Adobe Systems some years ago for document interchange, based on their PostScript language. A PDF reader (http://www.foolabs.com/xpdf/) for the X window system is freely available, as is the definition of the file format (http://partners.adobe.com/asn/developer/technotes/). Since PDF is a binary format, there are no `@ifpdf' or `@pdf' commands as with the other output formats. Despite the `portable' in the name, PDF files are nowhere near as portable in practice as the plain ASCII formats (Info, HTML) that Texinfo supports (DVI portability is arguable). They also tend to be much larger and do not support the bitmap fonts used by TeX (by default) very well. Nevertheless, a PDF file does preserve an actual printed document on a screen as faithfully as possible, so it has its place. PDF support in Texinfo is fairly rudimentary.  File: texinfo, Node: Creating and Installing Info Files, Next: Command List, Prev: Hardcopy, Up: Top Creating and Installing Info Files ********************************** This chapter describes how to create and install Info files. *Note Info Files::, for general information about the file format itself. * Menu: * Creating an Info File:: * Installing an Info File::  File: texinfo, Node: Creating an Info File, Next: Installing an Info File, Up: Creating and Installing Info Files Creating an Info File ===================== `makeinfo' is a program that converts a Texinfo file into an Info file, HTML file, or plain text. `texinfo-format-region' and `texinfo-format-buffer' are GNU Emacs functions that convert Texinfo to Info. For information on installing the Info file in the Info system, *note Installing an Info File::. * Menu: * makeinfo advantages:: `makeinfo' provides better error checking. * Invoking makeinfo:: How to run `makeinfo' from a shell. * makeinfo options:: Specify fill-column and other options. * Pointer Validation:: How to check that pointers point somewhere. * makeinfo in Emacs:: How to run `makeinfo' from Emacs. * texinfo-format commands:: Two Info formatting commands written in Emacs Lisp are an alternative to `makeinfo'. * Batch Formatting:: How to format for Info in Emacs Batch mode. * Tag and Split Files:: How tagged and split files help Info to run better. * makeinfo html:: Generating HTML output.  File: texinfo, Node: makeinfo advantages, Next: Invoking makeinfo, Up: Creating an Info File `makeinfo' Preferred -------------------- The `makeinfo' utility creates an Info file from a Texinfo source file more quickly than either of the Emacs formatting commands and provides better error messages. We recommend it. `makeinfo' is a C program that is independent of Emacs. You do not need to run Emacs to use `makeinfo', which means you can use `makeinfo' on machines that are too small to run Emacs. You can run `makeinfo' in any one of three ways: from an operating system shell, from a shell inside Emacs, or by typing the `C-c C-m C-r' or the `C-c C-m C-b' command in Texinfo mode in Emacs. The `texinfo-format-region' and the `texinfo-format-buffer' commands are useful if you cannot run `makeinfo'. Also, in some circumstances, they format short regions or buffers more quickly than `makeinfo'.  File: texinfo, Node: Invoking makeinfo, Next: makeinfo options, Prev: makeinfo advantages, Up: Creating an Info File Running `makeinfo' from a Shell ------------------------------- To create an Info file from a Texinfo file, type `makeinfo' followed by the name of the Texinfo file. Thus, to create the Info file for Bison, type the following to the shell: makeinfo bison.texinfo (You can run a shell inside Emacs by typing `M-x shell'.) Sometimes you will want to specify options. For example, if you wish to discover which version of `makeinfo' you are using, type: makeinfo --version *Note makeinfo options::, for more information.  File: texinfo, Node: makeinfo options, Next: Pointer Validation, Prev: Invoking makeinfo, Up: Creating an Info File Options for `makeinfo' ---------------------- The `makeinfo' command takes a number of options. Most often, options are used to set the value of the fill column and specify the footnote style. Each command line option is a word preceded by `--' or a letter preceded by `-'. You can use abbreviations for the long option names as long as they are unique. For example, you could use the following shell command to create an Info file for `bison.texinfo' in which each line is filled to only 68 columns: makeinfo --fill-column=68 bison.texinfo You can write two or more options in sequence, like this: makeinfo --no-split --fill-column=70 ... This would keep the Info file together as one possibly very long file and would also set the fill column to 70. The options are: `-D VAR' Cause the variable VAR to be defined. This is equivalent to `@set VAR' in the Texinfo file (*note set clear value::). `--commands-in-node-names' Allow `@'-commands in node names. This is not recommended, as it can probably never be implemented in TeX. It also makes `makeinfo' much slower. Also, this option is ignored when `--no-validate' is used. *Note Pointer Validation::, for more details. `--docbook' Generate DocBook output rather than Info. `--error-limit=LIMIT' `-e LIMIT' Set the maximum number of errors that `makeinfo' will report before exiting (on the assumption that continuing would be useless); default 100. `--fill-column=WIDTH' `-f WIDTH' Specify the maximum number of columns in a line; this is the right-hand edge of a line. Paragraphs that are filled will be filled to this width. (Filling is the process of breaking up and connecting lines so that lines are the same length as or shorter than the number specified as the fill column. Lines are broken between words.) The default value is 72. Ignored with `--html'. `--footnote-style=STYLE' `-s STYLE' Set the footnote style to STYLE, either `end' for the end node style (the default) or `separate' for the separate node style. The value set by this option overrides the value set in a Texinfo file by an `@footnotestyle' command (*note Footnotes::). When the footnote style is `separate', `makeinfo' makes a new node containing the footnotes found in the current node. When the footnote style is `end', `makeinfo' places the footnote references at the end of the current node. Ignored with `--html'. `--force' `-F' Ordinarily, if the input file has errors, the output files are not created. With this option, they are preserved. `--help' `-h' Print a usage message listing all available options, then exit successfully. `--html' Generate HTML output rather than Info. *Note makeinfo html::. By default, the HTML output is split into one output file per source node, and the split output is written into a subdirectory with the name of the top-level info file. `-I DIR' Append DIR to the directory search list for finding files that are included using the `@include' command. By default, `makeinfo' searches only the current directory. If DIR is not given, the current directory `.' is appended. Note that DIR can actually be a list of several directories separated by the usual path separator character (`:' on Unix, `;' on MS-DOS/MS-Windows). `--macro-expand=FILE' `-E FILE' Output the Texinfo source with all the macros expanded to the named file. Normally, the results of macro expansion are used internally by `makeinfo' and then discarded. This option is used by `texi2dvi' if you are using an old version of `texinfo.tex' that does not support `@macro'. `--no-headers' For Info output, do not include menus or node lines in the output and write to standard output (unless `--output' is specified). This results in an ASCII file that you cannot read in Info since it does not contain the requisite nodes or menus. It is primarily useful to extract certain pieces of a manual into separate files to be included in a distribution, such as `INSTALL' files. For HTML output, if `--no-split' is also specified, do not include a navigation links at the top of each node. *Note makeinfo html::. `--no-split' Suppress the splitting stage of `makeinfo'. By default, large output files (where the size is greater than 70k bytes) are split into smaller subfiles. For Info output, each one is approximately 50k bytes. For HTML output, each file contains one node (*note makeinfo html::). `--no-pointer-validate' `--no-validate' Suppress the pointer-validation phase of `makeinfo'. This can also be done with the `@novalidate' command (*note Use TeX: Use TeX.). Normally, after a Texinfo file is processed, some consistency checks are made to ensure that cross references can be resolved, etc. *Note Pointer Validation::. `--no-warn' Suppress warning messages (but _not_ error messages). You might want this if the file you are creating has examples of Texinfo cross references within it, and the nodes that are referenced do not actually exist. `--number-sections' Output chapter, section, and appendix numbers as in printed manuals. `--no-number-footnotes' Suppress automatic footnote numbering. By default, `makeinfo' numbers each footnote sequentially in a single node, resetting the current footnote number to 1 at the start of each node. `--output=FILE' `-o FILE' Specify that the output should be directed to FILE and not to the file name specified in the `@setfilename' command found in the Texinfo source (*note setfilename::). If FILE is `-', output goes to standard output and `--no-split' is implied. For split HTML output, FILE is the name for the directory into which all HTML nodes are written (*note makeinfo html::). `-P DIR' Prepend DIR to the directory search list for `@include'. If DIR is not given, the current directory `.' is prepended. See `-I' for more details. `--paragraph-indent=INDENT' `-p INDENT' Set the paragraph indentation style to INDENT. The value set by this option overrides the value set in a Texinfo file by an `@paragraphindent' command (*note paragraphindent::). The value of INDENT is interpreted as follows: `asis' Preserve any existing indentation at the starts of paragraphs. `0' or `none' Delete any existing indentation. NUM Indent each paragraph by NUM spaces. `--reference-limit=LIMIT' `-r LIMIT' Set the value of the number of references to a node that `makeinfo' will make without reporting a warning. If a node has more than this number of references in it, `makeinfo' will make the references but also report a warning. The default is 1000. `-U VAR' Cause VAR to be undefined. This is equivalent to `@clear VAR' in the Texinfo file (*note set clear value::). `--verbose' Cause `makeinfo' to display messages saying what it is doing. Normally, `makeinfo' only outputs messages if there are errors or warnings. `--version' `-V' Print the version number, then exit successfully. `--xml' Generate XML output rather than Info.  File: texinfo, Node: Pointer Validation, Next: makeinfo in Emacs, Prev: makeinfo options, Up: Creating an Info File Pointer Validation ------------------ If you do not suppress pointer validation with the `--no-validate' option or the `@novalidate' command in the source file (*note Use TeX: Use TeX.), `makeinfo' will check the validity of the final Info file. Mostly, this means ensuring that nodes you have referenced really exist. Here is a complete list of what is checked: 1. If a `Next', `Previous', or `Up' node reference is a reference to a node in the current file and is not an external reference such as to `(dir)', then the referenced node must exist. 2. In every node, if the `Previous' node is different from the `Up' node, then the node pointed to by the `Previous' field must have a `Next' field which points back to this node. 3. Every node except the `Top' node must have an `Up' pointer. 4. The node referenced by an `Up' pointer must itself reference the current node through a menu item, unless the node referenced by `Up' has the form `(FILE)'. 5. If the `Next' reference of a node is not the same as the `Next' reference of the `Up' reference, then the node referenced by the `Next' pointer must have a `Previous' pointer that points back to the current node. This rule allows the last node in a section to point to the first node of the next chapter. 6. Every node except `Top' should be referenced by at least one other node, either via the `Previous' or `Next' links, or via a menu or a cross-reference. Some Texinfo documents might fail during the validation phase because they use commands like `@value' and `@definfoenclose' in node definitions and cross-references inconsistently. Consider the following example: @set nodename Node 1 @node @value{nodename}, Node 2, Top, Top This is node 1. @node Node 2, , Node 1, Top This is node 2. Here, the node "Node 1" was referenced both verbatim and through `@value'. By default, `makeinfo' fails such cases, because node names are not fully expanded until they are written to the output file. You should always try to reference nodes consistently; e.g., in the above example, the second `@node' line should have also used `@value'. However, if, for some reason, you _must_ reference node names inconsistently, and `makeinfo' fails to validate the file, you can use the `--commands-in-node-names' option to force `makeinfo' to perform the expensive expansion of all node names it finds in the document. This might considerably slow down the program, though; twofold increase in conversion time was measured for large documents such as the Jargon file. The support for `@'-commands in `@node' directives is not general enough to be freely used. For example, if the example above redefined `nodename' somewhere in the document, `makeinfo' will fail to convert it, even if invoked with the `--commands-in-node-names' option. `--commands-in-node-names' has no effect if the `--no-validate' option is given.  File: texinfo, Node: makeinfo in Emacs, Next: texinfo-format commands, Prev: Pointer Validation, Up: Creating an Info File Running `makeinfo' inside Emacs ------------------------------- You can run `makeinfo' in GNU Emacs Texinfo mode by using either the `makeinfo-region' or the `makeinfo-buffer' commands. In Texinfo mode, the commands are bound to `C-c C-m C-r' and `C-c C-m C-b' by default. `C-c C-m C-r' `M-x makeinfo-region' Format the current region for Info. `C-c C-m C-b' `M-x makeinfo-buffer' Format the current buffer for Info. When you invoke either `makeinfo-region' or `makeinfo-buffer', Emacs prompts for a file name, offering the name of the visited file as the default. You can edit the default file name in the minibuffer if you wish, before pressing to start the `makeinfo' process. The Emacs `makeinfo-region' and `makeinfo-buffer' commands run the `makeinfo' program in a temporary shell buffer. If `makeinfo' finds any errors, Emacs displays the error messages in the temporary buffer. You can parse the error messages by typing `C-x `' (`next-error'). This causes Emacs to go to and position the cursor on the line in the Texinfo source that `makeinfo' thinks caused the error. *Note Running `make' or Compilers Generally: (emacs)Compilation, for more information about using the `next-error' command. In addition, you can kill the shell in which the `makeinfo' command is running or make the shell buffer display its most recent output. `C-c C-m C-k' `M-x makeinfo-kill-job' Kill the current running `makeinfo' job (from `makeinfo-region' or `makeinfo-buffer'). `C-c C-m C-l' `M-x makeinfo-recenter-output-buffer' Redisplay the `makeinfo' shell buffer to display its most recent output. (Note that the parallel commands for killing and recentering a TeX job are `C-c C-t C-k' and `C-c C-t C-l'. *Note Texinfo Mode Printing::.) You can specify options for `makeinfo' by setting the `makeinfo-options' variable with either the `M-x edit-options' or the `M-x set-variable' command, or by setting the variable in your `.emacs' initialization file. For example, you could write the following in your `.emacs' file: (setq makeinfo-options "--paragraph-indent=0 --no-split --fill-column=70 --verbose") For more information, see *Note Editing Variable Values: (emacs)Edit Options, *Note Examining and Setting Variables: (emacs)Examining, *Note Init File: (emacs)Init File, and *Note Options for `makeinfo': makeinfo options.  File: texinfo, Node: texinfo-format commands, Next: Batch Formatting, Prev: makeinfo in Emacs, Up: Creating an Info File The `texinfo-format...' Commands -------------------------------- In GNU Emacs in Texinfo mode, you can format part or all of a Texinfo file with the `texinfo-format-region' command. This formats the current region and displays the formatted text in a temporary buffer called `*Info Region*'. Similarly, you can format a buffer with the `texinfo-format-buffer' command. This command creates a new buffer and generates the Info file in it. Typing `C-x C-s' will save the Info file under the name specified by the `@setfilename' line which must be near the beginning of the Texinfo file. `C-c C-e C-r' ``texinfo-format-region'' Format the current region for Info. `C-c C-e C-b' ``texinfo-format-buffer'' Format the current buffer for Info. The `texinfo-format-region' and `texinfo-format-buffer' commands provide you with some error checking, and other functions can provide you with further help in finding formatting errors. These procedures are described in an appendix; see *Note Catching Mistakes::. However, the `makeinfo' program is often faster and provides better error checking (*note makeinfo in Emacs::).  File: texinfo, Node: Batch Formatting, Next: Tag and Split Files, Prev: texinfo-format commands, Up: Creating an Info File Batch Formatting ---------------- You can format Texinfo files for Info using `batch-texinfo-format' and Emacs Batch mode. You can run Emacs in Batch mode from any shell, including a shell inside of Emacs. (*Note Command Line Switches and Arguments: (emacs)Command Switches.) Here is a shell command to format all the files that end in `.texinfo' in the current directory: emacs -batch -funcall batch-texinfo-format *.texinfo Emacs processes all the files listed on the command line, even if an error occurs while attempting to format some of them. Run `batch-texinfo-format' only with Emacs in Batch mode as shown; it is not interactive. It kills the Batch mode Emacs on completion. `batch-texinfo-format' is convenient if you lack `makeinfo' and want to format several Texinfo files at once. When you use Batch mode, you create a new Emacs process. This frees your current Emacs, so you can continue working in it. (When you run `texinfo-format-region' or `texinfo-format-buffer', you cannot use that Emacs for anything else until the command finishes.)  File: texinfo, Node: Tag and Split Files, Next: makeinfo html, Prev: Batch Formatting, Up: Creating an Info File Tag Files and Split Files ------------------------- If a Texinfo file has more than 30,000 bytes, `texinfo-format-buffer' automatically creates a tag table for its Info file; `makeinfo' always creates a tag table. With a "tag table", Info can jump to new nodes more quickly than it can otherwise. In addition, if the Texinfo file contains more than about 70,000 bytes, `texinfo-format-buffer' and `makeinfo' split the large Info file into shorter "indirect" subfiles of about 50,000 bytes each. Big files are split into smaller files so that Emacs does not need to make a large buffer to hold the whole of a large Info file; instead, Emacs allocates just enough memory for the small, split-off file that is needed at the time. This way, Emacs avoids wasting memory when you run Info. (Before splitting was implemented, Info files were always kept short and "include files" were designed as a way to create a single, large printed manual out of the smaller Info files. *Note Include Files::, for more information. Include files are still used for very large documents, such as `The Emacs Lisp Reference Manual', in which each chapter is a separate file.) When a file is split, Info itself makes use of a shortened version of the original file that contains just the tag table and references to the files that were split off. The split-off files are called "indirect" files. The split-off files have names that are created by appending `-1', `-2', `-3' and so on to the file name specified by the `@setfilename' command. The shortened version of the original file continues to have the name specified by `@setfilename'. At one stage in writing this document, for example, the Info file was saved as the file `test-texinfo' and that file looked like this: Info file: test-texinfo, -*-Text-*- produced by texinfo-format-buffer from file: new-texinfo-manual.texinfo ^_ Indirect: test-texinfo-1: 102 test-texinfo-2: 50422 test-texinfo-3: 101300 ^_^L Tag table: (Indirect) Node: overview^?104 Node: info file^?1271 Node: printed manual^?4853 Node: conventions^?6855 ... (But `test-texinfo' had far more nodes than are shown here.) Each of the split-off, indirect files, `test-texinfo-1', `test-texinfo-2', and `test-texinfo-3', is listed in this file after the line that says `Indirect:'. The tag table is listed after the line that says `Tag table:'. In the list of indirect files, the number following the file name records the cumulative number of bytes in the preceding indirect files, not counting the file list itself, the tag table, or the permissions text in each file. In the tag table, the number following the node name records the location of the beginning of the node, in bytes from the beginning of the (unsplit) output. If you are using `texinfo-format-buffer' to create Info files, you may want to run the `Info-validate' command. (The `makeinfo' command does such a good job on its own, you do not need `Info-validate'.) However, you cannot run the `M-x Info-validate' node-checking command on indirect files. For information on how to prevent files from being split and how to validate the structure of the nodes, see *Note Using Info-validate::.  File: texinfo, Node: makeinfo html, Prev: Tag and Split Files, Up: Creating an Info File Generating HTML --------------- Besides generating output in the Info format, you can use the `--html' option to generate output in HTML format, for installation on a web site (for example). By default, the HTML output is split at node level. When splitting, the HTML output files are written into a subdirectory. The subdirectory is named according to the name from `@setfilename' with any extension removed; for example, HTML output for `@setfilename emacs.info' would be written into a subdirectory named `emacs'. If that directory cannot be created for any reason, then `.html' is appended to the directory name, as in `emacs.html' (this is necessary because sometimes the info file is named without an extension, e.g., `texinfo'). If the `NAME.html' directory can't be created either, `makeinfo' gives up. In any case, the top-level output file within the directory is always named `index.html'. Monolithic output (`--no-split') is named according to `@setfilename' or `--outfile'. Cross-document node references are not supported in monolithic HTML. Texinfo input marked up with the `@ifhtml' command will produce output only with the `--html' option supplied. Input marked up with the `@html' is passed literally to the output (suppressing the normal escaping of input `<', `>' and `&' characters which have special significance in HTML). The `--footnote-style' option is currently ignored for HTML output; footnotes are linked to the end of the output file. The HTML generated is mostly standard (i.e., HTML 2.0, RFC-1866). The exception is that HTML 3.2 tables are generated from the `@multitable' command, but tagged to degrade as well as possible in browsers without table support. Please report output from an error-free run of `makeinfo' which violates the HTML 3.2 DTD as a bug. Navigation bars are inserted at the start of nodes, similarly to Info output. The `--no-headers' option will suppress this if used with `--no-split'. Header `' elements in split output can support info-like navigation with browsers like Lynx and Emacs W3 which implement this HTML 1.0 feature. `@xref' commands to other documents are generated assuming the other document is available in split HTML form, and installed in the same HTML documentation tree, at `..//'.  File: texinfo, Node: Installing an Info File, Prev: Creating an Info File, Up: Creating and Installing Info Files Installing an Info File ======================= Info files are usually kept in the `info' directory. You can read Info files using the standalone Info program or the Info reader built into Emacs. (*note info: (info)Top, for an introduction to Info.) * Menu: * Directory File:: The top level menu for all Info files. * New Info File:: Listing a new info file. * Other Info Directories:: How to specify Info files that are located in other directories. * Installing Dir Entries:: How to specify what menu entry to add to the Info directory. * Invoking install-info:: `install-info' options.  File: texinfo, Node: Directory File, Next: New Info File, Up: Installing an Info File The Directory File `dir' ------------------------ For Info to work, the `info' directory must contain a file that serves as a top level directory for the Info system. By convention, this file is called `dir'. (You can find the location of this file within Emacs by typing `C-h i' to enter Info and then typing `C-x C-f' to see the pathname to the `info' directory.) The `dir' file is itself an Info file. It contains the top level menu for all the Info files in the system. The menu looks like this: * Menu: * Info: (info). Documentation browsing system. * Emacs: (emacs). The extensible, self-documenting text editor. * Texinfo: (texinfo). With one source file, make either a printed manual using @TeX{} or an Info file. ... Each of these menu entries points to the `Top' node of the Info file that is named in parentheses. (The menu entry does not need to specify the `Top' node, since Info goes to the `Top' node if no node name is mentioned. *Note Nodes in Other Info Files: Other Info Files.) Thus, the `Info' entry points to the `Top' node of the `info' file and the `Emacs' entry points to the `Top' node of the `emacs' file. In each of the Info files, the `Up' pointer of the `Top' node refers back to the `dir' file. For example, the line for the `Top' node of the Emacs manual looks like this in Info: File: emacs Node: Top, Up: (DIR), Next: Distrib In this case, the `dir' file name is written in upper case letters--it can be written in either upper or lower case. This is not true in general, it is a special case for `dir'.  File: texinfo, Node: New Info File, Next: Other Info Directories, Prev: Directory File, Up: Installing an Info File Listing a New Info File ----------------------- To add a new Info file to your system, you must write a menu entry to add to the menu in the `dir' file in the `info' directory. For example, if you were adding documentation for GDB, you would write the following new entry: * GDB: (gdb). The source-level C debugger. The first part of the menu entry is the menu entry name, followed by a colon. The second part is the name of the Info file, in parentheses, followed by a period. The third part is the description. The name of an Info file often has a `.info' extension. Thus, the Info file for GDB might be called either `gdb' or `gdb.info'. The Info reader programs automatically try the file name both with and without `.info'(1) (*note New Info File-Footnote-1::); so it is better to avoid clutter and not to write `.info' explicitly in the menu entry. For example, the GDB menu entry should use just `gdb' for the file name, not `gdb.info'.  File: texinfo, Node: New Info File-Footnotes, Up: New Info File (1) On MS-DOS/MS-Windows systems, Info will try the `.inf' extension as well.  File: texinfo, Node: Other Info Directories, Next: Installing Dir Entries, Prev: New Info File, Up: Installing an Info File Info Files in Other Directories ------------------------------- If an Info file is not in the `info' directory, there are three ways to specify its location: 1. Write the pathname in the `dir' file as the second part of the menu. 2. If you are using Emacs, list the name of the file in a second `dir' file, in its directory; and then add the name of that directory to the `Info-directory-list' variable in your personal or site initialization file. This variable tells Emacs where to look for `dir' files (the files must be named `dir'). Emacs merges the files named `dir' from each of the listed directories. (In Emacs version 18, you can set the `Info-directory' variable to the name of only one directory.) 3. Specify the Info directory name in the `INFOPATH' environment variable in your `.profile' or `.cshrc' initialization file. (Only you and others who set this environment variable will be able to find Info files whose location is specified this way.) For example, to reach a test file in the `/home/bob/info' directory, you could add an entry like this to the menu in the standard `dir' file: * Test: (/home/bob/info/info-test). Bob's own test file. In this case, the absolute file name of the `info-test' file is written as the second part of the menu entry. Alternatively, you could write the following in your `.emacs' file: (require 'info) (setq Info-directory-list (cons (expand-file-name "/home/bob/info") Info-directory-list)) This tells Emacs to merge the system `dir' file with the `dir' file in `/home/bob/info'. Thus, Info will list the `/home/bob/info/info-test' file as a menu entry in the `/home/bob/info/dir' file. Emacs does the merging only when `M-x info' is first run, so if you want to set `Info-directory-list' in an Emacs session where you've already run `info', you must `(setq Info-dir-contents nil)' to force Emacs to recompose the `dir' file. Finally, you can tell Info where to look by setting the `INFOPATH' environment variable in your shell startup file, such as `.cshrc', `.profile' or `autoexec.bat'. If you use a Bourne-compatible shell such as `sh' or `bash' for your shell command interpreter, you set the `INFOPATH' environment variable in the `.profile' initialization file; but if you use `csh' or `tcsh', you set the variable in the `.cshrc' initialization file. On MS-DOS/MS-Windows systems, you must set `INFOPATH' in your `autoexec.bat' file or in the Registry. Each type of shell uses a different syntax. * In a `.cshrc' file, you could set the `INFOPATH' variable as follows: setenv INFOPATH .:~/info:/usr/local/emacs/info * In a `.profile' file, you would achieve the same effect by writing: INFOPATH=.:$HOME/info:/usr/local/emacs/info export INFOPATH * In a `autoexec.bat' file, you write this command(1) (*note Other Info Directories-Footnote-1::): set INFOPATH=.;%HOME%/info;c:/usr/local/emacs/info The `.' indicates the current directory as usual. Emacs uses the `INFOPATH' environment variable to initialize the value of Emacs's own `Info-directory-list' variable. The stand-alone Info reader merges any files named `dir' in any directory listed in the `INFOPATH' variable into a single menu presented to you in the node called `(dir)Top'. However you set `INFOPATH', if its last character is a colon(2) (*note Other Info Directories-Footnote-2::), this is replaced by the default (compiled-in) path. This gives you a way to augment the default path with new directories without having to list all the standard places. For example (using `sh' syntax): INFOPATH=/local/info: export INFOPATH will search `/local/info' first, then the standard directories. Leading or doubled colons are not treated specially. When you create your own `dir' file for use with `Info-directory-list' or `INFOPATH', it's easiest to start by copying an existing `dir' file and replace all the text after the `* Menu:' with your desired entries. That way, the punctuation and special CTRL-_ characters that Info needs will be present.  File: texinfo, Node: Other Info Directories-Footnotes, Up: Other Info Directories (1) Note the use of `;' as the directory separator, and a different syntax for using values of other environment variables. (2) On MS-DOS/MS-Windows systems, use semi-colon instead.  File: texinfo, Node: Installing Dir Entries, Next: Invoking install-info, Prev: Other Info Directories, Up: Installing an Info File Installing Info Directory Files ------------------------------- When you install an Info file onto your system, you can use the program `install-info' to update the Info directory file `dir'. Normally the makefile for the package runs `install-info', just after copying the Info file into its proper installed location. In order for the Info file to work with `install-info', you should use the commands `@dircategory' and `@direntry'...`@end direntry' in the Texinfo source file. Use `@direntry' to specify the menu entries to add to the Info directory file, and use `@dircategory' to specify which part of the Info directory to put it in. Here is how these commands are used in this manual: @dircategory Texinfo documentation system @direntry * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. ... ... @end direntry Here's what this produces in the Info file: INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. ... ... END-INFO-DIR-ENTRY The `install-info' program sees these lines in the Info file, and that is how it knows what to do. Always use the `@direntry' and `@dircategory' commands near the beginning of the Texinfo input, before the first `@node' command. If you use them later on in the input, `install-info' will not notice them. If you use `@dircategory' more than once in the Texinfo source, each usage specifies the `current' category; any subsequent `@direntry' commands will add to that category. Here are some recommended `@dircategory' categories: GNU packages GNU programming tools GNU programming documentation GNU Emacs Lisp GNU libraries Linux TeX Individual utilities The idea is to include the `Invoking' node for every program installed by a package under `Individual utilities', and an entry for the manual as a whole in the appropriate other category. rs--it./info/texinfo-10 644 0 0 130035 7442531461 6762 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Invoking install-info, Prev: Installing Dir Entries, Up: Installing an Info File Invoking install-info --------------------- `install-info' inserts menu entries from an Info file into the top-level `dir' file in the Info system (see the previous sections for an explanation of how the `dir' file works). It's most often run as part of software installation, or when constructing a `dir' file for all manuals on a system. Synopsis: install-info [OPTION]... [INFO-FILE [DIR-FILE]] If INFO-FILE or DIR-FILE are not specified, the options (described below) that define them must be. There are no compile-time defaults, and standard input is never used. `install-info' can read only one Info file and write only one `dir' file per invocation. If DIR-FILE (however specified) does not exist, `install-info' creates it if possible (with no entries). If any input file is compressed with `gzip' (*note Invoking gzip: (gzip)Invoking gzip.), `install-info' automatically uncompresses it for reading. And if DIR-FILE is compressed, `install-info' also automatically leaves it compressed after writing any changes. If DIR-FILE itself does not exist, `install-info' tries to open `DIR-FILE.gz'. Options: `--delete' Delete the entries in INFO-FILE from DIR-FILE. The file name in the entry in DIR-FILE must be INFO-FILE (except for an optional `.info' in either one). Don't insert any new entries. `--dir-file=NAME' `-d NAME' Specify file name of the Info directory file. This is equivalent to using the DIR-FILE argument. `--entry=TEXT' `-e TEXT' Insert TEXT as an Info directory entry; TEXT should have the form of an Info menu item line plus zero or more extra lines starting with whitespace. If you specify more than one entry, they are all added. If you don't specify any entries, they are determined from information in the Info file itself. `--help' `-h' Display a usage message listing basic usage and all available options, then exit successfully. `--info-file=FILE' `-i FILE' Specify Info file to install in the directory. Equivalent to using the INFO-FILE argument. `--info-dir=DIR' `-D DIR' Specify the directory where `dir' resides. Equivalent to `--dir-file=DIR/dir'. `--item=TEXT' Same as `--entry=TEXT'. An Info directory entry is actually a menu item. `--quiet' Suppress warnings. `--remove' `-r' Same as `--delete'. `--section=SEC' `-s SEC' Put this file's entries in section SEC of the directory. If you specify more than one section, all the entries are added in each of the sections. If you don't specify any sections, they are determined from information in the Info file itself. `--version' `-V' Display version information and exit successfully.  File: texinfo, Node: Command List, Next: Tips, Prev: Creating and Installing Info Files, Up: Top @-Command List ************** Here is an alphabetical list of the @-commands in Texinfo. Square brackets, [ ], indicate optional arguments; an ellipsis, `...', indicates repeated text. `@WHITESPACE' An `@' followed by a space, tab, or newline produces a normal, stretchable, interword space. *Note Multiple Spaces::. `@!' Generate an exclamation point that really does end a sentence (usually after an end-of-sentence capital letter). *Note Ending a Sentence::. `@"' `@'' Generate an umlaut or acute accent, respectively, over the next character, as in o" and o'. *Note Inserting Accents::. `@*' Force a line break. Do not end a paragraph that uses `@*' with an `@refill' command. *Note Line Breaks::. `@,{C}' Generate a cedilla accent under C, as in c,. *Note Inserting Accents::. `@-' Insert a discretionary hyphenation point. *Note - and hyphenation::. `@.' Produce a period that really does end a sentence (usually after an end-of-sentence capital letter). *Note Ending a Sentence::. `@:' Indicate to TeX that an immediately preceding period, question mark, exclamation mark, or colon does not end a sentence. Prevent TeX from inserting extra whitespace as it does at the end of a sentence. The command has no effect on the Info file output. *Note Not Ending a Sentence::. `@=' Generate a macron (bar) accent over the next character, as in o=. *Note Inserting Accents::. `@?' Generate a question mark that really does end a sentence (usually after an end-of-sentence capital letter). *Note Ending a Sentence::. `@@' Stands for an at sign, `@'. *Note Inserting @ and braces: Braces Atsigns. `@^' `@`' Generate a circumflex (hat) or grave accent, respectively, over the next character, as in o^. *Note Inserting Accents::. `@{' Stands for a left brace, `{'. *Note Inserting @ and braces: Braces Atsigns. `@}' Stands for a right-hand brace, `}'. *Note Inserting @ and braces: Braces Atsigns. `@~' Generate a tilde accent over the next character, as in N~. *Note Inserting Accents::. `@AA{}' `@aa{}' Generate the uppercase and lowercase Scandinavian A-ring letters, respectively: AA, aa. *Note Inserting Accents::. `@acronym{ABBREV}' Tag ABBREV as an acronym, that is, an abbreviation written in all capital letters, such as `NASA'. *Note `acronym': acronym. `@AE{}' `@ae{}' Generate the uppercase and lowercase AE ligatures, respectively: AE, ae. *Note Inserting Accents::. `@afivepaper' Change page dimensions for the A5 paper size. *Note A4 Paper::. `@afourlatex' `@afourpaper' `@afourwide' Change page dimensions for the A4 paper size. *Note A4 Paper::. `@alias NEW=EXISTING' Make the command `@NEW' an alias for the existing command `@EXISTING'. *Note alias::. `@anchor{NAME}' Define NAME as the current location for use as a cross-reference target. *Note `@anchor': anchor. `@appendix TITLE' Begin an appendix. The title appears in the table of contents of a printed manual. In Info, the title is underlined with asterisks. *Note The `@unnumbered' and `@appendix' Commands: unnumbered & appendix. `@appendixsec TITLE' `@appendixsection TITLE' Begin an appendix section within an appendix. The section title appears in the table of contents of a printed manual. In Info, the title is underlined with equal signs. `@appendixsection' is a longer spelling of the `@appendixsec' command. *Note Section Commands: unnumberedsec appendixsec heading. `@appendixsubsec TITLE' Begin an appendix subsection within an appendix. The title appears in the table of contents of a printed manual. In Info, the title is underlined with hyphens. *Note Subsection Commands: unnumberedsubsec appendixsubsec subheading. `@appendixsubsubsec TITLE' Begin an appendix subsubsection within an appendix subsection. The title appears in the table of contents of a printed manual. In Info, the title is underlined with periods. *Note The `subsub' Commands: subsubsection. `@asis' Used following `@table', `@ftable', and `@vtable' to print the table's first column without highlighting ("as is"). *Note Making a Two-column Table: Two-column Tables. `@author AUTHOR' Typeset AUTHOR flushleft and underline it. *Note The `@title' and `@author' Commands: title subtitle author. `@b{TEXT}' Print TEXT in bold font. No effect in Info. *Note Fonts::. `@bullet{}' Generate a large round dot, or the closest possible thing to one. *Note `@bullet': bullet. `@bye' Stop formatting a file. The formatters do not see the contents of a file following an `@bye' command. *Note Ending a File::. `@c COMMENT' Begin a comment in Texinfo. The rest of the line does not appear in either the Info file or the printed manual. A synonym for `@comment'. *Note Comments: Comments. `@cartouche' Highlight an example or quotation by drawing a box with rounded corners around it. Pair with `@end cartouche'. No effect in Info. *Note Drawing Cartouches Around Examples: cartouche.) `@center LINE-OF-TEXT' Center the line of text following the command. *Note `@center': titlefont center sp. `@centerchap LINE-OF-TEXT' Like `@chapter', but centers the chapter title. *Note `@chapter': chapter. `@chapheading TITLE' Print a chapter-like heading in the text, but not in the table of contents of a printed manual. In Info, the title is underlined with asterisks. *Note `@majorheading' and `@chapheading': majorheading & chapheading. `@chapter TITLE' Begin a chapter. The chapter title appears in the table of contents of a printed manual. In Info, the title is underlined with asterisks. *Note `@chapter': chapter. `@cindex ENTRY' Add ENTRY to the index of concepts. *Note Defining the Entries of an Index: Index Entries. `@cite{REFERENCE}' Highlight the name of a book or other reference that lacks a companion Info file. *Note `@cite': cite. `@clear FLAG' Unset FLAG, preventing the Texinfo formatting commands from formatting text between subsequent pairs of `@ifset FLAG' and `@end ifset' commands, and preventing `@value{FLAG}' from expanding to the value to which FLAG is set. *Note `@set' `@clear' `@value': set clear value. `@code{SAMPLE-CODE}' Highlight text that is an expression, a syntactically complete token of a program, or a program name. *Note `@code': code. `@command{COMMAND-NAME}' Indicate a command name, such as `ls'. *Note `@command': command. `@comment COMMENT' Begin a comment in Texinfo. The rest of the line does not appear in either the Info file or the printed manual. A synonym for `@c'. *Note Comments::. `@contents' Print a complete table of contents. Has no effect in Info, which uses menus instead. *Note Generating a Table of Contents: Contents. `@copyright{}' Generate a copyright symbol. *Note `@copyright': copyright symbol. `@defcodeindex INDEX-NAME' Define a new index and its indexing command. Print entries in an `@code' font. *Note Defining New Indices: New Indices. `@defcv CATEGORY CLASS NAME' `@defcvx CATEGORY CLASS NAME' Format a description for a variable associated with a class in object-oriented programming. Takes three arguments: the category of thing being defined, the class to which it belongs, and its name. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@deffn CATEGORY NAME ARGUMENTS...' `@deffnx CATEGORY NAME ARGUMENTS...' Format a description for a function, interactive command, or similar entity that may take arguments. `@deffn' takes as arguments the category of entity being described, the name of this particular entity, and its arguments, if any. *Note Definition Commands::. `@defindex INDEX-NAME' Define a new index and its indexing command. Print entries in a roman font. *Note Defining New Indices: New Indices. `@definfoenclose NEWCMD, BEFORE, AFTER,' Create new @-command NEWCMD for Info that marks text by enclosing it in strings that precede and follow the text. *Note definfoenclose::. `@defivar CLASS INSTANCE-VARIABLE-NAME' `@defivarx CLASS INSTANCE-VARIABLE-NAME' This command formats a description for an instance variable in object-oriented programming. The command is equivalent to `@defcv {Instance Variable} ...'. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@defmac MACRONAME ARGUMENTS...' `@defmacx MACRONAME ARGUMENTS...' Format a description for a macro. The command is equivalent to `@deffn Macro ...'. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@defmethod CLASS METHOD-NAME ARGUMENTS...' `@defmethodx CLASS METHOD-NAME ARGUMENTS...' Format a description for a method in object-oriented programming. The command is equivalent to `@defop Method ...'. Takes as arguments the name of the class of the method, the name of the method, and its arguments, if any. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@defop CATEGORY CLASS NAME ARGUMENTS...' `@defopx CATEGORY CLASS NAME ARGUMENTS...' Format a description for an operation in object-oriented programming. `@defop' takes as arguments the overall name of the category of operation, the name of the class of the operation, the name of the operation, and its arguments, if any. *Note Definition Commands::, and *Note Abstract Objects::. `@defopt OPTION-NAME' `@defoptx OPTION-NAME' Format a description for a user option. The command is equivalent to `@defvr {User Option} ...'. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@defspec SPECIAL-FORM-NAME ARGUMENTS...' `@defspecx SPECIAL-FORM-NAME ARGUMENTS...' Format a description for a special form. The command is equivalent to `@deffn {Special Form} ...'. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@deftp CATEGORY NAME-OF-TYPE ATTRIBUTES...' `@deftpx CATEGORY NAME-OF-TYPE ATTRIBUTES...' Format a description for a data type. `@deftp' takes as arguments the category, the name of the type (which is a word like `int' or `float'), and then the names of attributes of objects of that type. *Note Definition Commands::, and *Note Data Types::. `@deftypefn CLASSIFICATION DATA-TYPE NAME ARGUMENTS...' `@deftypefnx CLASSIFICATION DATA-TYPE NAME ARGUMENTS...' Format a description for a function or similar entity that may take arguments and that is typed. `@deftypefn' takes as arguments the classification of entity being described, the type, the name of the entity, and its arguments, if any. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@deftypefun DATA-TYPE FUNCTION-NAME ARGUMENTS...' `@deftypefunx DATA-TYPE FUNCTION-NAME ARGUMENTS...' Format a description for a function in a typed language. The command is equivalent to `@deftypefn Function ...'. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@deftypeivar CLASS DATA-TYPE VARIABLE-NAME' `@deftypeivarx CLASS DATA-TYPE VARIABLE-NAME' Format a description for a typed instance variable in object-oriented programming. *Note Definition Commands::, and *Note Abstract Objects::. `@deftypemethod CLASS DATA-TYPE METHOD-NAME ARGUMENTS...' `@deftypemethodx CLASS DATA-TYPE METHOD-NAME ARGUMENTS...' Format a description for a typed method in object-oriented programming. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@deftypeop CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...' `@deftypeopx CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...' Format a description for a typed operation in object-oriented programming. *Note Definition Commands::, and *Note Abstract Objects::. `@deftypevar DATA-TYPE VARIABLE-NAME' `@deftypevarx DATA-TYPE VARIABLE-NAME' Format a description for a variable in a typed language. The command is equivalent to `@deftypevr Variable ...'. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@deftypevr CLASSIFICATION DATA-TYPE NAME' `@deftypevrx CLASSIFICATION DATA-TYPE NAME' Format a description for something like a variable in a typed language--an entity that records a value. Takes as arguments the classification of entity being described, the type, and the name of the entity. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@defun FUNCTION-NAME ARGUMENTS...' `@defunx FUNCTION-NAME ARGUMENTS...' Format a description for functions. The command is equivalent to `@deffn Function ...'. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@defvar VARIABLE-NAME' `@defvarx VARIABLE-NAME' Format a description for variables. The command is equivalent to `@defvr Variable ...'. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@defvr CATEGORY NAME' `@defvrx CATEGORY NAME' Format a description for any kind of variable. `@defvr' takes as arguments the category of the entity and the name of the entity. *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. `@detailmenu' Avoid `makeinfo' confusion stemming from the detailed node listing in a master menu. *Note Master Menu Parts::. `@dfn{TERM}' Highlight the introductory or defining use of a term. *Note `@dfn': dfn. `@dircategory DIRPART' Specify a part of the Info directory menu where this file's entry should go. *Note Installing Dir Entries::. `@direntry' Begin the Info directory menu entry for this file. Pair with `@end direntry'. *Note Installing Dir Entries::. `@display' Begin a kind of example. Like `@example' (indent text, do not fill), but do not select a new font. Pair with `@end display'. *Note `@display': display. `@dmn{DIMENSION}' Format a unit of measure, as in 12pt. Causes TeX to insert a thin space before DIMENSION. No effect in Info. *Note `@dmn': dmn. `@documentdescription' Set the document description text, included in the HTML output. Pair with `@end documentdescription'. *Note `@documentdescription': documentdescription. `@documentencoding ENC' Declare the input encoding to be ENC. *Note `@documentencoding': documentencoding. `@documentlanguage CC' Declare the document language as the two-character ISO-639 abbreviation CC. *Note `@documentlanguage': documentlanguage. `@dotaccent{C}' Generate a dot accent over the character C, as in o.. *Note Inserting Accents::. `@dots{}' Insert an ellipsis: `...'. *Note `@dots': dots. `@email{ADDRESS[, DISPLAYED-TEXT]}' Indicate an electronic mail address. *Note `@email': email. `@emph{TEXT}' Highlight TEXT; text is displayed in _italics_ in printed output, and surrounded by asterisks in Info. *Note Emphasizing Text: Emphasis. `@end ENVIRONMENT' Ends ENVIRONMENT, as in `@end example'. *Note @-commands: Formatting Commands. `@env{ENVIRONMENT-VARIABLE}' Indicate an environment variable name, such as `PATH'. *Note `@env': env. `@enddots{}' Generate an end-of-sentence of ellipsis, like this .... *Note `@dots{}': dots. `@enumerate [NUMBER-OR-LETTER]' Begin a numbered list, using `@item' for each entry. Optionally, start list with NUMBER-OR-LETTER. Pair with `@end enumerate'. *Note `@enumerate': enumerate. `@equiv{}' Indicate to the reader the exact equivalence of two forms with a glyph: `=='. *Note Equivalence::. `@error{}' Indicate to the reader with a glyph that the following text is an error message: `error-->'. *Note Error Glyph::. `@evenfooting [LEFT] @| [CENTER] @| [RIGHT]' `@evenheading [LEFT] @| [CENTER] @| [RIGHT]' Specify page footings resp. headings for even-numbered (left-hand) pages. Only allowed inside `@iftex'. *Note How to Make Your Own Headings: Custom Headings. `@everyfooting [LEFT] @| [CENTER] @| [RIGHT]' `@everyheading [LEFT] @| [CENTER] @| [RIGHT]' Specify page footings resp. headings for every page. Not relevant to Info. *Note How to Make Your Own Headings: Custom Headings. `@example' Begin an example. Indent text, do not fill, and select fixed-width font. Pair with `@end example'. *Note `@example': example. `@exampleindent INDENT' Indent example-like environments by INDENT number of spaces (perhaps 0). *Note Paragraph Indenting: exampleindent. `@exclamdown{}' Produce an upside-down exclamation point. *Note Inserting Accents::. `@exdent LINE-OF-TEXT' Remove any indentation a line might have. *Note Undoing the Indentation of a Line: exdent. `@expansion{}' Indicate the result of a macro expansion to the reader with a special glyph: `==>'. *Note ==> Indicating an Expansion: expansion. `@file{FILENAME}' Highlight the name of a file, buffer, node, or directory. *Note `@file': file. `@finalout' Prevent TeX from printing large black warning rectangles beside over-wide lines. *Note Overfull hboxes::. `@findex ENTRY' Add ENTRY to the index of functions. *Note Defining the Entries of an Index: Index Entries. `@flushleft' `@flushright' Left justify every line but leave the right end ragged. Leave font as is. Pair with `@end flushleft'. `@flushright' analogous. *Note `@flushleft' and `@flushright': flushleft & flushright. `@footnote{TEXT-OF-FOOTNOTE}' Enter a footnote. Footnote text is printed at the bottom of the page by TeX; Info may format in either `End' node or `Separate' node style. *Note Footnotes::. `@footnotestyle STYLE' Specify an Info file's footnote style, either `end' for the end node style or `separate' for the separate node style. *Note Footnotes::. `@format' Begin a kind of example. Like `@display', but do not narrow the margins. Pair with `@end format'. *Note `@example': example. `@ftable FORMATTING-COMMAND' Begin a two-column table, using `@item' for each entry. Automatically enter each of the items in the first column into the index of functions. Pair with `@end ftable'. The same as `@table', except for indexing. *Note `@ftable' and `@vtable': ftable vtable. `@group' Hold text together that must appear on one printed page. Pair with `@end group'. Not relevant to Info. *Note `@group': group. `@H{C}' Generate the long Hungarian umlaut accent over C, as in o''. `@heading TITLE' Print an unnumbered section-like heading in the text, but not in the table of contents of a printed manual. In Info, the title is underlined with equal signs. *Note Section Commands: unnumberedsec appendixsec heading. `@headings ON-OFF-SINGLE-DOUBLE' Turn page headings on or off, and/or specify single-sided or double-sided page headings for printing. *Note The `@headings' Command: headings on off. `@html' Enter HTML completely. Pair with `@end html'. *Note Raw Formatter Commands::. `@hyphenation{HY-PHEN-A-TED WORDS}' Explicitly define hyphenation points. *Note `@-' and `@hyphenation': - and hyphenation. `@i{TEXT}' Print TEXT in italic font. No effect in Info. *Note Fonts::. `@ifclear FLAG' If FLAG is cleared, the Texinfo formatting commands format text between `@ifclear FLAG' and the following `@end ifclear' command. *Note `@set' `@clear' `@value': set clear value. `@ifhtml' `@ifinfo' Begin a stretch of text that will be ignored by TeX when it typesets the printed manual. The text appears only in the HTML resp. Info file. Pair with `@end ifhtml' resp. `@end ifinfo'. *Note Conditionals::. `@ifnothtml' `@ifnotinfo' `@ifnottex' Begin a stretch of text that will be ignored in one output format but not the others. The text appears only in the format not specified. Pair with `@end ifnothtml' resp. `@end ifnotinfo' resp. `@end ifnotinfo'. *Note Conditionals::. `@ifset FLAG' If FLAG is set, the Texinfo formatting commands format text between `@ifset FLAG' and the following `@end ifset' command. *Note `@set' `@clear' `@value': set clear value. `@iftex' Begin a stretch of text that will not appear in the Info file, but will be processed only by TeX. Pair with `@end iftex'. *Note Conditionally Visible Text: Conditionals. `@ignore' Begin a stretch of text that will not appear in either the Info file or the printed output. Pair with `@end ignore'. *Note Comments and Ignored Text: Comments. `@image{FILENAME, [WIDTH], [HEIGHT], [ALT], [EXT]}' Include graphics image in external FILENAME scaled to the given WIDTH and/or HEIGHT, using ALT text and looking for `FILENAME.EXT' in HTML. *Note Images::. `@include FILENAME' Incorporate the contents of the file FILENAME into the Info file or printed document. *Note Include Files::. `@inforef{NODE-NAME, [ENTRY-NAME], INFO-FILE-NAME}' Make a cross reference to an Info file for which there is no printed manual. *Note Cross references using `@inforef': inforef. `\input MACRO-DEFINITIONS-FILE' Use the specified macro definitions file. This command is used only in the first line of a Texinfo file to cause TeX to make use of the `texinfo' macro definitions file. The backslash in `\input' is used instead of an `@' because TeX does not recognize `@' until after it has read the definitions file. *Note The Texinfo File Header: Header. `@item' Indicate the beginning of a marked paragraph for `@itemize' and `@enumerate'; indicate the beginning of the text of a first column entry for `@table', `@ftable', and `@vtable'. *Note Lists and Tables::. `@itemize MARK-GENERATING-CHARACTER-OR-COMMAND' Produce a sequence of indented paragraphs, with a mark inside the left margin at the beginning of each paragraph. Pair with `@end itemize'. *Note `@itemize': itemize. `@itemx' Like `@item' but do not generate extra vertical space above the item text. *Note `@itemx': itemx. `@kbd{KEYBOARD-CHARACTERS}' Indicate text that is characters of input to be typed by users. *Note `@kbd': kbd. `@kbdinputstyle STYLE' Specify when `@kbd' should use a font distinct from `@code'. *Note `@kbd': kbd. `@key{KEY-NAME}' Indicate a name for a key on a keyboard. *Note `@key': key. `@kindex ENTRY' Add ENTRY to the index of keys. *Note Defining the Entries of an Index: Index Entries. `@L{}' `@l{}' Generate the uppercase and lowercase Polish suppressed-L letters, respectively: /L, /l. `@lisp' Begin an example of Lisp code. Indent text, do not fill, and select fixed-width font. Pair with `@end lisp'. *Note `@lisp': lisp. `@lowersections' Change subsequent chapters to sections, sections to subsections, and so on. *Note `@raisesections' and `@lowersections': Raise/lower sections. `@macro MACRONAME {PARAMS}' Define a new Texinfo command `@MACRONAME{PARAMS}'. Only supported by `makeinfo' and `texi2dvi'. *Note Defining Macros::. `@majorheading TITLE' Print a chapter-like heading in the text, but not in the table of contents of a printed manual. Generate more vertical whitespace before the heading than the `@chapheading' command. In Info, the chapter heading line is underlined with asterisks. *Note `@majorheading' and `@chapheading': majorheading & chapheading. `@math{MATHEMATICAL-EXPRESSION}' Format a mathematical expression. *Note `@math': Inserting Mathematical Expressions: math. `@menu' Mark the beginning of a menu of nodes in Info. No effect in a printed manual. Pair with `@end menu'. *Note Menus::. `@minus{}' Generate a minus sign, `-'. *Note `@minus': minus. `@multitable COLUMN-WIDTH-SPEC' Begin a multi-column table. Pair with `@end multitable'. *Note Multitable Column Widths::. `@need N' Start a new page in a printed manual if fewer than N mils (thousandths of an inch) remain on the current page. *Note `@need': need. `@node NAME, NEXT, PREVIOUS, UP' Define the beginning of a new node in Info, and serve as a locator for references for TeX. *Note `@node': node. `@noindent' Prevent text from being indented as if it were a new paragraph. *Note `@noindent': noindent. `@novalidate' Suppress validation of node references, omit creation of auxiliary files with TeX. Use before `@setfilename'. *Note Pointer Validation::. `@O{}' `@o{}' Generate the uppercase and lowercase O-with-slash letters, respectively: /O, /o. `@oddfooting [LEFT] @| [CENTER] @| [RIGHT]' `@oddheading [LEFT] @| [CENTER] @| [RIGHT]' Specify page footings resp. headings for odd-numbered (right-hand) pages. Only allowed inside `@iftex'. *Note How to Make Your Own Headings: Custom Headings. `@OE{}' `@oe{}' Generate the uppercase and lowercase OE ligatures, respectively: Œ, œ. *Note Inserting Accents::. `@option{OPTION-NAME}' Indicate a command-line option, such as `-l' or `--help'. *Note `@option': option. `@page' Start a new page in a printed manual. No effect in Info. *Note `@page': page. `@pagesizes [WIDTH][, HEIGHT]' Change page dimensions. *Note pagesizes::. `@paragraphindent INDENT' Indent paragraphs by INDENT number of spaces (perhaps 0); preserve source file indentation if INDENT is `asis'. *Note Paragraph Indenting: paragraphindent. `@pindex ENTRY' Add ENTRY to the index of programs. *Note Defining the Entries of an Index: Index Entries. `@point{}' Indicate the position of point in a buffer to the reader with a glyph: `-!-'. *Note Indicating Point in a Buffer: Point Glyph. `@pounds{}' Generate the pounds sterling currency sign. *Note `@pounds{}': pounds. `@print{}' Indicate printed output to the reader with a glyph: `-|'. *Note Print Glyph::. `@printindex INDEX-NAME' Print an alphabetized two-column index in a printed manual or generate an alphabetized menu of index entries for Info. *Note Printing Indices & Menus::. `@pxref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}' Make a reference that starts with a lower case `see' in a printed manual. Use within parentheses only. Do not follow command with a punctuation mark--the Info formatting commands automatically insert terminating punctuation as needed. Only the first argument is mandatory. *Note `@pxref': pxref. `@questiondown{}' Generate an upside-down question mark. *Note Inserting Accents::. `@quotation' Narrow the margins to indicate text that is quoted from another real or imaginary work. Write command on a line of its own. Pair with `@end quotation'. *Note `@quotation': quotation. `@r{TEXT}' Print TEXT in roman font. No effect in Info. *Note Fonts::. `@raisesections' Change subsequent sections to chapters, subsections to sections, and so on. *Note `@raisesections' and `@lowersections': Raise/lower sections. `@ref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}' Make a reference. In a printed manual, the reference does not start with a `See'. Follow command with a punctuation mark. Only the first argument is mandatory. *Note `@ref': ref. `@refill' In Info, refill and indent the paragraph after all the other processing has been done. No effect on TeX, which always refills. This command is no longer needed, since all formatters now automatically refill. *Note Refilling Paragraphs::. `@result{}' Indicate the result of an expression to the reader with a special glyph: `=>'. *Note `@result': result. `@ringaccent{C}' Generate a ring accent over the next character, as in o*. *Note Inserting Accents::. `@samp{TEXT}' Highlight TEXT that is a literal example of a sequence of characters. Used for single characters, for statements, and often for entire shell commands. *Note `@samp': samp. `@sc{TEXT}' Set TEXT in a printed output in THE SMALL CAPS FONT and set text in the Info file in uppercase letters. *Note Smallcaps::. `@section TITLE' Begin a section within a chapter. In a printed manual, the section title is numbered and appears in the table of contents. In Info, the title is underlined with equal signs. *Note `@section': section. `@set FLAG [STRING]' Make FLAG active, causing the Texinfo formatting commands to format text between subsequent pairs of `@ifset FLAG' and `@end ifset' commands. Optionally, set value of FLAG to STRING. *Note `@set' `@clear' `@value': set clear value. `@setchapternewpage ON-OFF-ODD' Specify whether chapters start on new pages, and if so, whether on odd-numbered (right-hand) new pages. *Note `@setchapternewpage': setchapternewpage. `@setcontentsaftertitlepage' Put the table of contents after the `@end titlepage' even if the `@contents' command is not there. *Note Contents::. `@setfilename INFO-FILE-NAME' Provide a name to be used by the Info file. This command is essential for TeX formatting as well, even though it produces no output. *Note `@setfilename': setfilename. `@setshortcontentsaftertitlepage' Place the short table of contents after the `@end titlepage' command even if the `@shortcontents' command is not there. *Note Contents::. `@settitle TITLE' Provide a title for page headers in a printed manual, and the default document description for HTML `'. *Note `@settitle': settitle. `@shortcontents' Print a short table of contents. Not relevant to Info, which uses menus rather than tables of contents. A synonym for `@summarycontents'. *Note Generating a Table of Contents: Contents. `@shorttitlepage TITLE' Generate a minimal title page. *Note `@titlepage': titlepage. `@smallbook' Cause TeX to produce a printed manual in a 7 by 9.25 inch format rather than the regular 8.5 by 11 inch format. *Note Printing Small Books: smallbook. Also, see *Note small::. `@smalldisplay' Begin a kind of example. Like `@smallexample' (narrow margins, no filling), but do not select the fixed-width font. Pair with `@end smalldisplay'. *Note small::. `@smallexample' Indent text to indicate an example. Do not fill, select fixed-width font, narrow the margins. In printed manuals, print text in a smaller font than with `@example'. Pair with `@end smallexample'. *Note small::. `@smallformat' Begin a kind of example. Like `@smalldisplay', but do not narrow the margins. Pair with `@end smallformat'. *Note small::. `@smalllisp' Begin an example of Lisp code. Same as `@smallexample'. Pair with `@end smalllisp'. *Note small::. `@sp N' Skip N blank lines. *Note `@sp': sp. `@ss{}' Generate the German sharp-S es-zet letter, ss. *Note Inserting Accents::. `@strong {TEXT}' Emphasize TEXT by typesetting it in a *bold* font for the printed manual and by surrounding it with asterisks for Info. *Note Emphasizing Text: emph & strong. `@subheading TITLE' Print an unnumbered subsection-like heading in the text, but not in the table of contents of a printed manual. In Info, the title is underlined with hyphens. *Note `@unnumberedsubsec' `@appendixsubsec' `@subheading': unnumberedsubsec appendixsubsec subheading. `@subsection TITLE' Begin a subsection within a section. In a printed manual, the subsection title is numbered and appears in the table of contents. In Info, the title is underlined with hyphens. *Note `@subsection': subsection. `@subsubheading TITLE' Print an unnumbered subsubsection-like heading in the text, but not in the table of contents of a printed manual. In Info, the title is underlined with periods. *Note The `subsub' Commands: subsubsection. `@subsubsection TITLE' Begin a subsubsection within a subsection. In a printed manual, the subsubsection title is numbered and appears in the table of contents. In Info, the title is underlined with periods. *Note The `subsub' Commands: subsubsection. `@subtitle TITLE' In a printed manual, set a subtitle in a normal sized font flush to the right-hand side of the page. Not relevant to Info, which does not have title pages. *Note `@title' `@subtitle' and `@author' Commands: title subtitle author. `@summarycontents' Print a short table of contents. Not relevant to Info, which uses menus rather than tables of contents. A synonym for `@shortcontents'. *Note Generating a Table of Contents: Contents. `@syncodeindex FROM-INDEX INTO-INDEX' Merge the index named in the first argument into the index named in the second argument, printing the entries from the first index in `@code' font. *Note Combining Indices::. `@synindex FROM-INDEX INTO-INDEX' Merge the index named in the first argument into the index named in the second argument. Do not change the font of FROM-INDEX entries. *Note Combining Indices::. `@t{TEXT}' Print TEXT in a fixed-width, typewriter-like font. No effect in Info. *Note Fonts::. `@tab' Separate columns in a multitable. *Note Multitable Rows::. `@table FORMATTING-COMMAND' Begin a two-column table, using `@item' for each entry. Write each first column entry on the same line as `@item'. First column entries are printed in the font resulting from FORMATTING-COMMAND. Pair with `@end table'. *Note Making a Two-column Table: Two-column Tables. Also see *Note `@ftable' and `@vtable': ftable vtable, and *Note `@itemx': itemx. `@TeX{}' Insert the logo TeX. *Note Inserting TeX and (C): TeX and copyright. `@tex' Enter TeX completely. Pair with `@end tex'. *Note Raw Formatter Commands::. `@thischapter' `@thischaptername' `@thisfile' `@thispage' `@thistitle' Only allowed in a heading or footing. Stands for the number and name of the current chapter (in the format `Chapter 1: Title'), the chapter name only, the filename, the current page number, and the title of the document, respectively. *Note How to Make Your Own Headings: Custom Headings. `@tieaccent{CC}' Generate a tie-after accent over the next two characters CC, as in `oo['. *Note Inserting Accents::. `@tindex ENTRY' Add ENTRY to the index of data types. *Note Defining the Entries of an Index: Index Entries. `@title TITLE' In a printed manual, set a title flush to the left-hand side of the page in a larger than normal font and underline it with a black rule. Not relevant to Info, which does not have title pages. *Note The `@title' `@subtitle' and `@author' Commands: title subtitle author. `@titlefont{TEXT}' In a printed manual, print TEXT in a larger than normal font. Not relevant to Info, which does not have title pages. *Note The `@titlefont' `@center' and `@sp' Commands: titlefont center sp. `@titlepage' Indicate to Texinfo the beginning of the title page. Write command on a line of its own. Pair with `@end titlepage'. Nothing between `@titlepage' and `@end titlepage' appears in Info. *Note `@titlepage': titlepage. `@today{}' Insert the current date, in `1 Jan 1900' style. *Note How to Make Your Own Headings: Custom Headings. `@top TITLE' In a Texinfo file to be formatted with `makeinfo', identify the topmost `@node' line in the file, which must be written on the line immediately preceding the `@top' command. Used for `makeinfo''s node pointer insertion feature. The title is underlined with asterisks. Both the `@node' line and the `@top' line normally should be enclosed by `@ifinfo' and `@end ifinfo'. In TeX and `texinfo-format-buffer', the `@top' command is merely a synonym for `@unnumbered'. *Note Creating Pointers with `makeinfo': makeinfo Pointer Creation. `@u{C}' `@ubaraccent{C}' `@udotaccent{C}' Generate a breve, underbar, or underdot accent, respectively, over or under the character C, as in o(, o_, .o. *Note Inserting Accents::. `@unnumbered TITLE' In a printed manual, begin a chapter that appears without chapter numbers of any kind. The title appears in the table of contents of a printed manual. In Info, the title is underlined with asterisks. *Note `@unnumbered' and `@appendix': unnumbered & appendix. `@unnumberedsec TITLE' In a printed manual, begin a section that appears without section numbers of any kind. The title appears in the table of contents of a printed manual. In Info, the title is underlined with equal signs. *Note Section Commands: unnumberedsec appendixsec heading. `@unnumberedsubsec TITLE' In a printed manual, begin an unnumbered subsection within a chapter. The title appears in the table of contents of a printed manual. In Info, the title is underlined with hyphens. *Note `@unnumberedsubsec' `@appendixsubsec' `@subheading': unnumberedsubsec appendixsubsec subheading. `@unnumberedsubsubsec TITLE' In a printed manual, begin an unnumbered subsubsection within a chapter. The title appears in the table of contents of a printed manual. In Info, the title is underlined with periods. *Note The `subsub' Commands: subsubsection. `@uref{URL[, DISPLAYED-TEXT][, REPLACEMENT}' Define a cross reference to an external uniform resource locator for the World Wide Web. *Note `@uref': uref. `@url{URL}' Indicate text that is a uniform resource locator for the World Wide Web. *Note `@url': url. `@v{C}' Generate check accent over the character C, as in o<. *Note Inserting Accents::. `@value{FLAG}' Replace FLAG with the value to which it is set by `@set FLAG'. *Note `@set' `@clear' `@value': set clear value. `@var{METASYNTACTIC-VARIABLE}' Highlight a metasyntactic variable, which is something that stands for another piece of text. *Note Indicating Metasyntactic Variables: var. `@verb{DELIM LITERAL DELIM}' Output LITERAL, delimited by the single character DELIM, exactly as is (in the fixed-width font), including any whitespace or Texinfo special characters. *Note `verb': verb. `@verbatim' Output the text of the environment exactly as is (in the fixed-width font). Pair with `@end verbatim'. *Note `verbatim': verbatim. `@verbatiminclude FILENAME' Output the contents of FILENAME exactly as is (in the fixed-width font). *Note `verbatiminclude': verbatiminclude. `@vindex ENTRY' Add ENTRY to the index of variables. *Note Defining the Entries of an Index: Index Entries. `@vskip AMOUNT' In a printed manual, insert whitespace so as to push text on the remainder of the page towards the bottom of the page. Used in formatting the copyright page with the argument `0pt plus 1filll'. (Note spelling of `filll'.) `@vskip' may be used only in contexts ignored for Info. *Note The Copyright Page and Printed Permissions: Copyright & Permissions. `@vtable FORMATTING-COMMAND' Begin a two-column table, using `@item' for each entry. Automatically enter each of the items in the first column into the index of variables. Pair with `@end vtable'. The same as `@table', except for indexing. *Note `@ftable' and `@vtable': ftable vtable. `@w{TEXT}' Prevent TEXT from being split across two lines. Do not end a paragraph that uses `@w' with an `@refill' command. *Note `@w': w. `@xref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}' Make a reference that starts with `See' in a printed manual. Follow command with a punctuation mark. Only the first argument is mandatory. *Note `@xref': xref. of a printed manual. In Info, the title is underlined with periods. *Note The `subsub' Commands: subsubsection. `@subsubsection TITLE' Begin a subsubsection within a subsection. In a printed manual, the subsubsection title is numbered and appears in the table of contents. In Info, the title is underlined with periods. *Note The `subsub' Commands: subsubsection. `@subtitle TITLE' In a printed manual, set a subtitle in a normal sized font ./info/texinfo-11 644 0 0 143062 7442531461 6767 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Tips, Next: Sample Texinfo File, Prev: Command List, Up: Top Tips and Hints ************** Here are some tips for writing Texinfo documentation: * Write in the present tense, not in the past or the future. * Write actively! For example, write "We recommend that ..." rather than "It is recommended that ...". * Use 70 or 72 as your fill column. Longer lines are hard to read. * Include a copyright notice and copying permissions. Index, Index, Index! .................... Write many index entries, in different ways. Readers like indices; they are helpful and convenient. Although it is easiest to write index entries as you write the body of the text, some people prefer to write entries afterwards. In either case, write an entry before the paragraph to which it applies. This way, an index entry points to the first page of a paragraph that is split across pages. Here are more hints we have found valuable: * Write each index entry differently, so each entry refers to a different place in the document. * Write index entries only where a topic is discussed significantly. For example, it is not useful to index "debugging information" in a chapter on reporting bugs. Someone who wants to know about debugging information will certainly not find it in that chapter. * Consistently capitalize the first word of every concept index entry, or else consistently use lower case. Terse entries often call for lower case; longer entries for capitalization. Whichever case convention you use, please use one or the other consistently! Mixing the two styles looks bad. * Always capitalize or use upper case for those words in an index for which this is proper, such as names of countries or acronyms. Always use the appropriate case for case-sensitive names, such as those in C or Lisp. * Write the indexing commands that refer to a whole section immediately after the section command, and write the indexing commands that refer to a paragraph before that paragraph. In the example that follows, a blank line comes after the index entry for "Leaping": @section The Dog and the Fox @cindex Jumping, in general @cindex Leaping @cindex Dog, lazy, jumped over @cindex Lazy dog jumped over @cindex Fox, jumps over dog @cindex Quick fox jumps over dog The quick brown fox jumps over the lazy dog. (Note that the example shows entries for the same concept that are written in different ways--`Lazy dog', and `Dog, lazy'--so readers can look up the concept in different ways.) Blank Lines ........... * Insert a blank line between a sectioning command and the first following sentence or paragraph, or between the indexing commands associated with the sectioning command and the first following sentence or paragraph, as shown in the tip on indexing. Otherwise, a formatter may fold title and paragraph together. * Always insert a blank line before an `@table' command and after an `@end table' command; but never insert a blank line after an `@table' command or before an `@end table' command. For example, Types of fox: @table @samp @item Quick Jump over lazy dogs. @item Brown Also jump over lazy dogs. @end table @noindent On the other hand, ... Insert blank lines before and after `@itemize' ... `@end itemize' and `@enumerate' ... `@end enumerate' in the same way. Complete Phrases ................ Complete phrases are easier to read than ... * Write entries in an itemized list as complete sentences; or at least, as complete phrases. Incomplete expressions ... awkward ... like this. * Write the prefatory sentence or phrase for a multi-item list or table as a complete expression. Do not write "You can set:"; instead, write "You can set these variables:". The former expression sounds cut off. Editions, Dates and Versions ............................ Write the edition and version numbers and date in three places in every manual: 1. In the first `@ifinfo' section, for people reading the Texinfo file. 2. In the `@titlepage' section, for people reading the printed manual. 3. In the `Top' node, for people reading the Info file. Also, it helps to write a note before the first `@ifinfo' section to explain what you are doing. For example: @c ===> NOTE! <== @c Specify the edition and version numbers and date @c in *three* places: @c 1. First ifinfo section 2. title page 3. top node @c To find the locations, search for !!set @ifinfo @c !!set edition, date, version This is Edition 4.03, January 1992, of the @cite{GDB Manual} for GDB Version 4.3. ... --or use `@set' and `@value' (*note `@value' Example: value Example.). Definition Commands ................... Definition commands are `@deffn', `@defun', `@defmac', and the like, and enable you to write descriptions in a uniform format. * Write just one definition command for each entity you define with a definition command. The automatic indexing feature creates an index entry that leads the reader to the definition. * Use `@table' ... `@end table' in an appendix that contains a summary of functions, not `@deffn' or other definition commands. Capitalization .............. * Capitalize "Texinfo"; it is a name. Do not write the `x' or `i' in upper case. * Capitalize "Info"; it is a name. * Write TeX using the `@TeX{}' command. Note the uppercase `T' and `X'. This command causes the formatters to typeset the name according to the wishes of Donald Knuth, who wrote TeX. Spaces ...... Do not use spaces to format a Texinfo file, except inside of `@example' ... `@end example' and similar commands. For example, TeX fills the following: @kbd{C-x v} @kbd{M-x vc-next-action} Perform the next logical operation on the version-controlled file corresponding to the current buffer. so it looks like this: `C-x v' `M-x vc-next-action' Perform the next logical operation on the version-controlled file corresponding to the current buffer. In this case, the text should be formatted with `@table', `@item', and `@itemx', to create a table. @code, @samp, @var, and `---' ............................. * Use `@code' around Lisp symbols, including command names. For example, The main function is @code{vc-next-action}, ... * Avoid putting letters such as `s' immediately after an `@code'. Such letters look bad. * Use `@var' around meta-variables. Do not write angle brackets around them. * Use three hyphens in a row, `---', to indicate a long dash. TeX typesets these as a long dash and the Info formatters reduce three hyphens to two. Periods Outside of Quotes ......................... Place periods and other punctuation marks _outside_ of quotations, unless the punctuation is part of the quotation. This practice goes against publishing conventions in the United States, but enables the reader to distinguish between the contents of the quotation and the whole passage. For example, you should write the following sentence with the period outside the end quotation marks: Evidently, `au' is an abbreviation for ``author''. since `au' does _not_ serve as an abbreviation for `author.' (with a period following the word). Introducing New Terms ..................... * Introduce new terms so that a reader who does not know them can understand them from context; or write a definition for the term. For example, in the following, the terms "check in", "register" and "delta" are all appearing for the first time; the example sentence should be rewritten so they are understandable. The major function assists you in checking in a file to your version control system and registering successive sets of changes to it as deltas. * Use the `@dfn' command around a word being introduced, to indicate that the reader should not expect to know the meaning already, and should expect to learn the meaning from this passage. @pxref ...... Absolutely never use `@pxref' except in the special context for which it is designed: inside parentheses, with the closing parenthesis following immediately after the closing brace. One formatter automatically inserts closing punctuation and the other does not. This means that the output looks right both in printed output and in an Info file, but only when the command is used inside parentheses. Invoking from a Shell ..................... You can invoke programs such as Emacs, GCC, and `gawk' from a shell. The documentation for each program should contain a section that describes this. Unfortunately, if the node names and titles for these sections are all different, they are difficult for users to find. So, there is a convention to name such sections with a phrase beginning with the word `Invoking', as in `Invoking Emacs'; this way, users can find the section easily. ANSI C Syntax ............. When you use `@example' to describe a C function's calling conventions, use the ANSI C syntax, like this: void dld_init (char *@var{path}); And in the subsequent discussion, refer to the argument values by writing the same argument names, again highlighted with `@var'. Avoid the obsolete style that looks like this: #include dld_init (path) char *path; Also, it is best to avoid writing `#include' above the declaration just to indicate that the function is declared in a header file. The practice may give the misimpression that the `#include' belongs near the declaration of the function. Either state explicitly which header file holds the declaration or, better yet, name the header file used for a group of functions at the beginning of the section that describes the functions. Bad Examples ............ Here are several examples of bad writing to avoid: In this example, say, " ... you must `@dfn'{check in} the new version." That flows better. When you are done editing the file, you must perform a `@dfn'{check in}. In the following example, say, "... makes a unified interface such as VC mode possible." SCCS, RCS and other version-control systems all perform similar functions in broadly similar ways (it is this resemblance which makes a unified control mode like this possible). And in this example, you should specify what `it' refers to: If you are working with other people, it assists in coordinating everyone's changes so they do not step on each other. And Finally ... ............... * Pronounce TeX as if the `X' were a Greek `chi', as the last sound in the name `Bach'. But pronounce Texinfo as in `speck': "teckinfo". * Write notes for yourself at the very end of a Texinfo file after the `@bye'. None of the formatters process text after the `@bye'; it is as if the text were within `@ignore' ... `@end ignore'.  File: texinfo, Node: Sample Texinfo File, Next: Include Files, Prev: Tips, Up: Top A Sample Texinfo File ********************* Here is a complete, short sample Texinfo file, without any commentary. You can see this file, with comments, in the first chapter. *Note A Short Sample Texinfo File: Short Sample. \input texinfo @c -*-texinfo-*- @c %**start of header @setfilename sample.info @settitle Sample Document @c %**end of header @ifinfo This is a short example of a complete Texinfo file. Copyright (C) 2002 Free Software Foundation, Inc. @end ifinfo @titlepage @comment The title is printed in a large font. @title Sample Title @c The following two commands start the copyright page. @page @vskip 0pt plus 1filll Copyright @copyright{} 2002 Free Software Foundation, Inc. @end titlepage @c Output the table of the contents at the beginning. @contents @ifnottex @node Top This is the top node of a sample document. @end ifnottex @menu * First Chapter:: The first chapter is the only chapter in this sample. * Concept Index:: This index has two entries. @end menu @node First Chapter @chapter First Chapter @cindex Chapter, first This is the contents of the first chapter. @cindex Another sample index entry Here is a numbered list. @enumerate @item This is the first item. @item This is the second item. @end enumerate The @code{makeinfo} command transforms a Texinfo source file such as this into an Info file or HTML; and @TeX typesets it for a printed manual. @node Concept Index @unnumbered Concept Index @printindex cp @bye  File: texinfo, Node: Include Files, Next: Headings, Prev: Sample Texinfo File, Up: Top Include Files ************* When TeX or an Info formatting command sees an `@include' command in a Texinfo file, it processes the contents of the file named by the command and incorporates them into the DVI or Info file being created. Index entries from the included file are incorporated into the indices of the output file. Include files let you keep a single large document as a collection of conveniently small parts. * Menu: * Using Include Files:: How to use the `@include' command. * texinfo-multiple-files-update:: How to create and update nodes and menus when using included files. * Include File Requirements:: What `texinfo-multiple-files-update' expects. * Sample Include File:: A sample outer file with included files within it; and a sample included file. * Include Files Evolution:: How use of the `@include' command has changed over time.  File: texinfo, Node: Using Include Files, Next: texinfo-multiple-files-update, Prev: Include Files, Up: Include Files How to Use Include Files ======================== To include another file within a Texinfo file, write the `@include' command at the beginning of a line and follow it on the same line by the name of a file to be included. For example: @include buffers.texi An included file should simply be a segment of text that you expect to be included as is into the overall or "outer" Texinfo file; it should not contain the standard beginning and end parts of a Texinfo file. In particular, you should not start an included file with a line saying `\input texinfo'; if you do, that phrase is inserted into the output file as is. Likewise, you should not end an included file with an `@bye' command; nothing after `@bye' is formatted. In the past, you were required to write an `@setfilename' line at the beginning of an included file, but no longer. Now, it does not matter whether you write such a line. If an `@setfilename' line exists in an included file, it is ignored. Conventionally, an included file begins with an `@node' line that is followed by an `@chapter' line. Each included file is one chapter. This makes it easy to use the regular node and menu creating and updating commands to create the node pointers and menus within the included file. However, the simple Emacs node and menu creating and updating commands do not work with multiple Texinfo files. Thus you cannot use these commands to fill in the `Next', `Previous', and `Up' pointers of the `@node' line that begins the included file. Also, you cannot use the regular commands to create a master menu for the whole file. Either you must insert the menus and the `Next', `Previous', and `Up' pointers by hand, or you must use the GNU Emacs Texinfo mode command, `texinfo-multiple-files-update', that is designed for `@include' files.  File: texinfo, Node: texinfo-multiple-files-update, Next: Include File Requirements, Prev: Using Include Files, Up: Include Files `texinfo-multiple-files-update' =============================== GNU Emacs Texinfo mode provides the `texinfo-multiple-files-update' command. This command creates or updates `Next', `Previous', and `Up' pointers of included files as well as those in the outer or overall Texinfo file, and it creates or updates a main menu in the outer file. Depending whether you call it with optional arguments, the command updates only the pointers in the first `@node' line of the included files or all of them: `M-x texinfo-multiple-files-update' Called without any arguments: - Create or update the `Next', `Previous', and `Up' pointers of the first `@node' line in each file included in an outer or overall Texinfo file. - Create or update the `Top' level node pointers of the outer or overall file. - Create or update a main menu in the outer file. `C-u M-x texinfo-multiple-files-update' Called with `C-u' as a prefix argument: - Create or update pointers in the first `@node' line in each included file. - Create or update the `Top' level node pointers of the outer file. - Create and insert a master menu in the outer file. The master menu is made from all the menus in all the included files. `C-u 8 M-x texinfo-multiple-files-update' Called with a numeric prefix argument, such as `C-u 8': - Create or update *all* the `Next', `Previous', and `Up' pointers of all the included files. - Create or update *all* the menus of all the included files. - Create or update the `Top' level node pointers of the outer or overall file. - And then create a master menu in the outer file. This is similar to invoking `texinfo-master-menu' with an argument when you are working with just one file. Note the use of the prefix argument in interactive use: with a regular prefix argument, just `C-u', the `texinfo-multiple-files-update' command inserts a master menu; with a numeric prefix argument, such as `C-u 8', the command updates *every* pointer and menu in *all* the files and then inserts a master menu.  File: texinfo, Node: Include File Requirements, Next: Sample Include File, Prev: texinfo-multiple-files-update, Up: Include Files Include File Requirements ========================= If you plan to use the `texinfo-multiple-files-update' command, the outer Texinfo file that lists included files within it should contain nothing but the beginning and end parts of a Texinfo file, and a number of `@include' commands listing the included files. It should not even include indices, which should be listed in an included file of their own. Moreover, each of the included files must contain exactly one highest level node (conventionally, `@chapter' or equivalent), and this node must be the first node in the included file. Furthermore, each of these highest level nodes in each included file must be at the same hierarchical level in the file structure. Usually, each is an `@chapter', an `@appendix', or an `@unnumbered' node. Thus, normally, each included file contains one, and only one, chapter or equivalent-level node. The outer file should contain only _one_ node, the `Top' node. It should _not_ contain any nodes besides the single `Top' node. The `texinfo-multiple-files-update' command will not process them.  File: texinfo, Node: Sample Include File, Next: Include Files Evolution, Prev: Include File Requirements, Up: Include Files Sample File with `@include' =========================== Here is an example of a complete outer Texinfo file with `@include' files within it before running `texinfo-multiple-files-update', which would insert a main or master menu: \input texinfo @c -*-texinfo-*- @setfilename include-example.info @settitle Include Example @setchapternewpage odd @titlepage @sp 12 @center @titlefont{Include Example} @sp 2 @center by Whom Ever @page @vskip 0pt plus 1filll Copyright @copyright{} 2002 Free Software Foundation, Inc. @end titlepage @ifinfo @node Top, First, , (dir) @top Master Menu @end ifinfo @include foo.texinfo @include bar.texinfo @include concept-index.texinfo @summarycontents @contents @bye An included file, such as `foo.texinfo', might look like this: @node First, Second, , Top @chapter First Chapter Contents of first chapter ... The full contents of `concept-index.texinfo' might be as simple as this: @node Concept Index @unnumbered Concept Index @printindex cp The outer Texinfo source file for `The GNU Emacs Lisp Reference Manual' is named `elisp.texi'. This outer file contains a master menu with 417 entries and a list of 41 `@include' files.  File: texinfo, Node: Include Files Evolution, Prev: Sample Include File, Up: Include Files Evolution of Include Files ========================== When Info was first created, it was customary to create many small Info files on one subject. Each Info file was formatted from its own Texinfo source file. This custom meant that Emacs did not need to make a large buffer to hold the whole of a large Info file when someone wanted information; instead, Emacs allocated just enough memory for the small Info file that contained the particular information sought. This way, Emacs could avoid wasting memory. References from one file to another were made by referring to the file name as well as the node name. (*Note Referring to Other Info Files: Other Info Files. Also, see *Note `@xref' with Four and Five Arguments: Four and Five Arguments.) Include files were designed primarily as a way to create a single, large printed manual out of several smaller Info files. In a printed manual, all the references were within the same document, so TeX could automatically determine the references' page numbers. The Info formatting commands used include files only for creating joint indices; each of the individual Texinfo files had to be formatted for Info individually. (Each, therefore, required its own `@setfilename' line.) However, because large Info files are now split automatically, it is no longer necessary to keep them small. Nowadays, multiple Texinfo files are used mostly for large documents, such as `The GNU Emacs Lisp Reference Manual', and for projects in which several different people write different sections of a document simultaneously. In addition, the Info formatting commands have been extended to work with the `@include' command so as to create a single large Info file that is split into smaller files if necessary. This means that you can write menus and cross references without naming the different Texinfo files.  File: texinfo, Node: Headings, Next: Catching Mistakes, Prev: Include Files, Up: Top Page Headings ************* Most printed manuals contain headings along the top of every page except the title and copyright pages. Some manuals also contain footings. (Headings and footings have no meaning to Info, which is not paginated.) * Menu: * Headings Introduced:: Conventions for using page headings. * Heading Format:: Standard page heading formats. * Heading Choice:: How to specify the type of page heading. * Custom Headings:: How to create your own headings and footings.  File: texinfo, Node: Headings Introduced, Next: Heading Format, Prev: Headings, Up: Headings Headings Introduced =================== Texinfo provides standard page heading formats for manuals that are printed on one side of each sheet of paper and for manuals that are printed on both sides of the paper. Typically, you will use these formats, but you can specify your own format if you wish. In addition, you can specify whether chapters should begin on a new page, or merely continue the same page as the previous chapter; and if chapters begin on new pages, you can specify whether they must be odd-numbered pages. By convention, a book is printed on both sides of each sheet of paper. When you open a book, the right-hand page is odd-numbered, and chapters begin on right-hand pages--a preceding left-hand page is left blank if necessary. Reports, however, are often printed on just one side of paper, and chapters begin on a fresh page immediately following the end of the preceding chapter. In short or informal reports, chapters often do not begin on a new page at all, but are separated from the preceding text by a small amount of whitespace. The `@setchapternewpage' command controls whether chapters begin on new pages, and whether one of the standard heading formats is used. In addition, Texinfo has several heading and footing commands that you can use to generate your own heading and footing formats. In Texinfo, headings and footings are single lines at the tops and bottoms of pages; you cannot create multiline headings or footings. Each header or footer line is divided into three parts: a left part, a middle part, and a right part. Any part, or a whole line, may be left blank. Text for the left part of a header or footer line is set flushleft; text for the middle part is centered; and, text for the right part is set flushright.  File: texinfo, Node: Heading Format, Next: Heading Choice, Prev: Headings Introduced, Up: Headings Standard Heading Formats ======================== Texinfo provides two standard heading formats, one for manuals printed on one side of each sheet of paper, and the other for manuals printed on both sides of the paper. By default, nothing is specified for the footing of a Texinfo file, so the footing remains blank. The standard format for single-sided printing consists of a header line in which the left-hand part contains the name of the chapter, the central part is blank, and the right-hand part contains the page number. A single-sided page looks like this: _______________________ | | | chapter page number | | | | Start of text ... | | ... | | | The standard format for two-sided printing depends on whether the page number is even or odd. By convention, even-numbered pages are on the left- and odd-numbered pages are on the right. (TeX will adjust the widths of the left- and right-hand margins. Usually, widths are correct, but during double-sided printing, it is wise to check that pages will bind properly--sometimes a printer will produce output in which the even-numbered pages have a larger right-hand margin than the odd-numbered pages.) In the standard double-sided format, the left part of the left-hand (even-numbered) page contains the page number, the central part is blank, and the right part contains the title (specified by the `@settitle' command). The left part of the right-hand (odd-numbered) page contains the name of the chapter, the central part is blank, and the right part contains the page number. Two pages, side by side as in an open book, look like this: _______________________ _______________________ | | | | | page number title | | chapter page number | | | | | | Start of text ... | | More text ... | | ... | | ... | | | | | The chapter name is preceded by the word "Chapter", the chapter number and a colon. This makes it easier to keep track of where you are in the manual.  File: texinfo, Node: Heading Choice, Next: Custom Headings, Prev: Heading Format, Up: Headings Specifying the Type of Heading ============================== TeX does not begin to generate page headings for a standard Texinfo file until it reaches the `@end titlepage' command. Thus, the title and copyright pages are not numbered. The `@end titlepage' command causes TeX to begin to generate page headings according to a standard format specified by the `@setchapternewpage' command that precedes the `@titlepage' section. There are four possibilities: No `@setchapternewpage' command Cause TeX to specify the single-sided heading format, with chapters on new pages. This is the same as `@setchapternewpage on'. `@setchapternewpage on' Specify the single-sided heading format, with chapters on new pages. `@setchapternewpage off' Cause TeX to start a new chapter on the same page as the last page of the preceding chapter, after skipping some vertical whitespace. Also cause TeX to typeset for single-sided printing. (You can override the headers format with the `@headings double' command; see *Note The `@headings' Command: headings on off.) `@setchapternewpage odd' Specify the double-sided heading format, with chapters on new pages. Texinfo lacks an `@setchapternewpage even' command.  File: texinfo, Node: Custom Headings, Prev: Heading Choice, Up: Headings How to Make Your Own Headings ============================= You can use the standard headings provided with Texinfo or specify your own. By default, Texinfo has no footers, so if you specify them, the available page size for the main text will be slightly reduced. Texinfo provides six commands for specifying headings and footings: * `@everyheading' `@everyfooting' generate page headers and footers that are the same for both even- and odd-numbered pages. * `@evenheading' and `@evenfooting' command generate headers and footers for even-numbered (left-hand) pages. * `@oddheading' and `@oddfooting' generate headers and footers for odd-numbered (right-hand) pages. Write custom heading specifications in the Texinfo file immediately after the `@end titlepage' command. Enclose your specifications between `@iftex' and `@end iftex' commands since the `texinfo-format-buffer' command may not recognize them. Also, you must cancel the predefined heading commands with the `@headings off' command before defining your own specifications. Here is how to tell TeX to place the chapter name at the left, the page number in the center, and the date at the right of every header for both even- and odd-numbered pages: @iftex @headings off @everyheading @thischapter @| @thispage @| @today{} @end iftex You need to divide the left part from the central part and the central part from the right part by inserting `@|' between parts. Otherwise, the specification command will not be able to tell where the text for one part ends and the next part begins. Each part can contain text or @-commands. The text is printed as if the part were within an ordinary paragraph in the body of the page. The @-commands replace themselves with the page number, date, chapter name, or whatever. Here are the six heading and footing commands: `@everyheading LEFT @| CENTER @| RIGHT' `@everyfooting LEFT @| CENTER @| RIGHT' The `every' commands specify the format for both even- and odd-numbered pages. These commands are for documents that are printed on one side of each sheet of paper, or for documents in which you want symmetrical headers or footers. `@evenheading LEFT @| CENTER @| RIGHT' `@oddheading LEFT @| CENTER @| RIGHT' `@evenfooting LEFT @| CENTER @| RIGHT' `@oddfooting LEFT @| CENTER @| RIGHT' The `even' and `odd' commands specify the format for even-numbered pages and odd-numbered pages. These commands are for books and manuals that are printed on both sides of each sheet of paper. Use the `@this...' series of @-commands to provide the names of chapters and sections and the page number. You can use the `@this...' commands in the left, center, or right portions of headers and footers, or anywhere else in a Texinfo file so long as they are between `@iftex' and `@end iftex' commands. Here are the `@this...' commands: `@thispage' Expands to the current page number. `@thischaptername' Expands to the name of the current chapter. `@thischapter' Expands to the number and name of the current chapter, in the format `Chapter 1: Title'. `@thistitle' Expands to the name of the document, as specified by the `@settitle' command. `@thisfile' For `@include' files only: expands to the name of the current `@include' file. If the current Texinfo source file is not an `@include' file, this command has no effect. This command does _not_ provide the name of the current Texinfo source file unless it is an `@include' file. (*Note Include Files::, for more information about `@include' files.) You can also use the `@today{}' command, which expands to the current date, in `1 Jan 1900' format. Other @-commands and text are printed in a header or footer just as if they were in the body of a page. It is useful to incorporate text, particularly when you are writing drafts: @iftex @headings off @everyheading @emph{Draft!} @| @thispage @| @thischapter @everyfooting @| @| Version: 0.27: @today{} @end iftex Beware of overlong titles: they may overlap another part of the header or footer and blot it out.  File: texinfo, Node: Catching Mistakes, Next: Refilling Paragraphs, Prev: Headings, Up: Top Formatting Mistakes ******************* Besides mistakes in the content of your documentation, there are two kinds of mistake you can make with Texinfo: you can make mistakes with @-commands, and you can make mistakes with the structure of the nodes and chapters. Emacs has two tools for catching the @-command mistakes and two for catching structuring mistakes. For finding problems with @-commands, you can run TeX or a region formatting command on the region that has a problem; indeed, you can run these commands on each region as you write it. For finding problems with the structure of nodes and chapters, you can use `C-c C-s' (`texinfo-show-structure') and the related `occur' command and you can use the `M-x Info-validate' command. * Menu: * makeinfo Preferred:: `makeinfo' finds errors. * Debugging with Info:: How to catch errors with Info formatting. * Debugging with TeX:: How to catch errors with TeX formatting. * Using texinfo-show-structure:: How to use `texinfo-show-structure'. * Using occur:: How to list all lines containing a pattern. * Running Info-Validate:: How to find badly referenced nodes.  File: texinfo, Node: makeinfo Preferred, Next: Debugging with Info, Prev: Catching Mistakes, Up: Catching Mistakes `makeinfo' Find Errors ====================== The `makeinfo' program does an excellent job of catching errors and reporting them--far better than `texinfo-format-region' or `texinfo-format-buffer'. In addition, the various functions for automatically creating and updating node pointers and menus remove many opportunities for human error. If you can, use the updating commands to create and insert pointers and menus. These prevent many errors. Then use `makeinfo' (or its Texinfo mode manifestations, `makeinfo-region' and `makeinfo-buffer') to format your file and check for other errors. This is the best way to work with Texinfo. But if you cannot use `makeinfo', or your problem is very puzzling, then you may want to use the tools described in this appendix.  File: texinfo, Node: Debugging with Info, Next: Debugging with TeX, Prev: makeinfo Preferred, Up: Catching Mistakes Catching Errors with Info Formatting ==================================== After you have written part of a Texinfo file, you can use the `texinfo-format-region' or the `makeinfo-region' command to see whether the region formats properly. Most likely, however, you are reading this section because for some reason you cannot use the `makeinfo-region' command; therefore, the rest of this section presumes that you are using `texinfo-format-region'. If you have made a mistake with an @-command, `texinfo-format-region' will stop processing at or after the error and display an error message. To see where in the buffer the error occurred, switch to the `*Info Region*' buffer; the cursor will be in a position that is after the location of the error. Also, the text will not be formatted after the place where the error occurred (or more precisely, where it was detected). For example, if you accidentally end a menu with the command `@end menus' with an `s' on the end, instead of with `@end menu', you will see an error message that says: @end menus is not handled by texinfo The cursor will stop at the point in the buffer where the error occurs, or not long after it. The buffer will look like this: ---------- Buffer: *Info Region* ---------- * Menu: * Using texinfo-show-structure:: How to use `texinfo-show-structure' to catch mistakes. * Running Info-Validate:: How to check for unreferenced nodes. @end menus -!- ---------- Buffer: *Info Region* ---------- The `texinfo-format-region' command sometimes provides slightly odd error messages. For example, the following cross reference fails to format: (@xref{Catching Mistakes, for more info.) In this case, `texinfo-format-region' detects the missing closing brace but displays a message that says `Unbalanced parentheses' rather than `Unbalanced braces'. This is because the formatting command looks for mismatches between braces as if they were parentheses. Sometimes `texinfo-format-region' fails to detect mistakes. For example, in the following, the closing brace is swapped with the closing parenthesis: (@xref{Catching Mistakes), for more info.} Formatting produces: (*Note for more info.: Catching Mistakes) The only way for you to detect this error is to realize that the reference should have looked like this: (*Note Catching Mistakes::, for more info.) Incidentally, if you are reading this node in Info and type `f ' (`Info-follow-reference'), you will generate an error message that says: No such node: "Catching Mistakes) The only way ... This is because Info perceives the example of the error as the first cross reference in this node and if you type a immediately after typing the Info `f' command, Info will attempt to go to the referenced node. If you type `f catch ', Info will complete the node name of the correctly written example and take you to the `Catching Mistakes' node. (If you try this, you can return from the `Catching Mistakes' node by typing `l' (`Info-last').)  File: texinfo, Node: Debugging with TeX, Next: Using texinfo-show-structure, Prev: Debugging with Info, Up: Catching Mistakes Catching Errors with TeX Formatting =================================== You can also catch mistakes when you format a file with TeX. Usually, you will want to do this after you have run `texinfo-format-buffer' (or, better, `makeinfo-buffer') on the same file, because `texinfo-format-buffer' sometimes displays error messages that make more sense than TeX. (*Note Debugging with Info::, for more information.) For example, TeX was run on a Texinfo file, part of which is shown here: ---------- Buffer: texinfo.texi ---------- name of the Texinfo file as an extension. The @samp{??} are `wildcards' that cause the shell to substitute all the raw index files. (@xref{sorting indices, for more information about sorting indices.)@refill ---------- Buffer: texinfo.texi ---------- (The cross reference lacks a closing brace.) TeX produced the following output, after which it stopped: ---------- Buffer: *tex-shell* ---------- Runaway argument? {sorting indices, for more information about sorting indices.) @refill @ETC. ! Paragraph ended before @xref was complete. @par l.27 ? ---------- Buffer: *tex-shell* ---------- In this case, TeX produced an accurate and understandable error message: Paragraph ended before @xref was complete. `@par' is an internal TeX command of no relevance to Texinfo. `l.27' means that TeX detected the problem on line 27 of the Texinfo file. The `?' is the prompt TeX uses in this circumstance. Unfortunately, TeX is not always so helpful, and sometimes you must truly be a Sherlock Holmes to discover what went wrong. In any case, if you run into a problem like this, you can do one of three things. 1. You can tell TeX to continue running and ignore just this error by typing at the `?' prompt. 2. You can tell TeX to continue running and to ignore all errors as best it can by typing `r ' at the `?' prompt. This is often the best thing to do. However, beware: the one error may produce a cascade of additional error messages as its consequences are felt through the rest of the file. To stop TeX when it is producing such an avalanche of error messages, type `C-c' (or `C-c C-c', if you are running a shell inside Emacs). 3. You can tell TeX to stop this run by typing `x ' at the `?' prompt. If you are running TeX inside Emacs, you need to switch to the shell buffer and line at which TeX offers the `?' prompt. Sometimes TeX will format a file without producing error messages even though there is a problem. This usually occurs if a command is not ended but TeX is able to continue processing anyhow. For example, if you fail to end an itemized list with the `@end itemize' command, TeX will write a DVI file that you can print out. The only error message that TeX will give you is the somewhat mysterious comment that (@end occurred inside a group at level 1) However, if you print the DVI file, you will find that the text of the file that follows the itemized list is entirely indented as if it were part of the last item in the itemized list. The error message is the way TeX says that it expected to find an `@end' command somewhere in the file; but that it could not determine where it was needed. Another source of notoriously hard-to-find errors is a missing `@end group' command. If you ever are stumped by incomprehensible errors, look for a missing `@end group' command first. If the Texinfo file lacks header lines, TeX may stop in the beginning of its run and display output that looks like the following. The `*' indicates that TeX is waiting for input. This is TeX, Version 3.14159 (Web2c 7.0) (test.texinfo [1]) * In this case, simply type `\end ' after the asterisk. Then write the header lines in the Texinfo file and run the TeX command again. (Note the use of the backslash, `\'. TeX uses `\' instead of `@'; and in this circumstance, you are working directly with TeX, not with Texinfo.)  File: texinfo, Node: Using texinfo-show-structure, Next: Using occur, Prev: Debugging with TeX, Up: Catching Mistakes Using `texinfo-show-structure' ============================== It is not always easy to keep track of the nodes, chapters, sections, and subsections of a Texinfo file. This is especially true if you are revising or adding to a Texinfo file that someone else has written. In GNU Emacs, in Texinfo mode, the `texinfo-show-structure' command lists all the lines that begin with the @-commands that specify the structure: `@chapter', `@section', `@appendix', and so on. With an argument (`C-u' as prefix argument, if interactive), the command also shows the `@node' lines. The `texinfo-show-structure' command is bound to `C-c C-s' in Texinfo mode, by default. The lines are displayed in a buffer called the `*Occur*' buffer, indented by hierarchical level. For example, here is a part of what was produced by running `texinfo-show-structure' on this manual: Lines matching "^@\\(chapter \\|sect\\|subs\\|subh\\| unnum\\|major\\|chapheading \\|heading \\|appendix\\)" in buffer texinfo.texi. ... 4177:@chapter Nodes 4198: @heading Two Paths 4231: @section Node and Menu Illustration 4337: @section The @code{@@node} Command 4393: @subheading Choosing Node and Pointer Names 4417: @subsection How to Write an @code{@@node} Line 4469: @subsection @code{@@node} Line Tips ... This says that lines 4337, 4393, and 4417 of `texinfo.texi' begin with the `@section', `@subheading', and `@subsection' commands respectively. If you move your cursor into the `*Occur*' window, you can position the cursor over one of the lines and use the `C-c C-c' command (`occur-mode-goto-occurrence'), to jump to the corresponding spot in the Texinfo file. *Note Using Occur: (emacs)Other Repeating Search, for more information about `occur-mode-goto-occurrence'. The first line in the `*Occur*' window describes the "regular expression" specified by TEXINFO-HEADING-PATTERN. This regular expression is the pattern that `texinfo-show-structure' looks for. *Note Using Regular Expressions: (emacs)Regexps, for more information. When you invoke the `texinfo-show-structure' command, Emacs will display the structure of the whole buffer. If you want to see the structure of just a part of the buffer, of one chapter, for example, use the `C-x n n' (`narrow-to-region') command to mark the region. (*Note Narrowing: (emacs)Narrowing.) This is how the example used above was generated. (To see the whole buffer again, use `C-x n w' (`widen').) If you call `texinfo-show-structure' with a prefix argument by typing `C-u C-c C-s', it will list lines beginning with `@node' as well as the lines beginning with the @-sign commands for `@chapter', `@section', and the like. You can remind yourself of the structure of a Texinfo file by looking at the list in the `*Occur*' window; and if you have mis-named a node or left out a section, you can correct the mistake.  File: texinfo, Node: Using occur, Next: Running Info-Validate, Prev: Using texinfo-show-structure, Up: Catching Mistakes Using `occur' ============= Sometimes the `texinfo-show-structure' command produces too much information. Perhaps you want to remind yourself of the overall structure of a Texinfo file, and are overwhelmed by the detailed list produced by `texinfo-show-structure'. In this case, you can use the `occur' command directly. To do this, type M-x occur and then, when prompted, type a "regexp", a regular expression for the pattern you want to match. (*Note Regular Expressions: (emacs)Regexps.) The `occur' command works from the current location of the cursor in the buffer to the end of the buffer. If you want to run `occur' on the whole buffer, place the cursor at the beginning of the buffer. For example, to see all the lines that contain the word `@chapter' in them, just type `@chapter'. This will produce a list of the chapters. It will also list all the sentences with `@chapter' in the middle of the line. If you want to see only those lines that start with the word `@chapter', type `^@chapter' when prompted by `occur'. If you want to see all the lines that end with a word or phrase, end the last word with a `$'; for example, `catching mistakes$'. This can be helpful when you want to see all the nodes that are part of the same chapter or section and therefore have the same `Up' pointer. *Note Using Occur: (emacs)Other Repeating Search, for more information.  File: texinfo, Node: Running Info-Validate, Prev: Using occur, Up: Catching Mistakes Finding Badly Referenced Nodes ============================== You can use the `Info-validate' command to check whether any of the `Next', `Previous', `Up' or other node pointers fail to point to a node. This command checks that every node pointer points to an existing node. The `Info-validate' command works only on Info files, not on Texinfo files. The `makeinfo' program validates pointers automatically, so you do not need to use the `Info-validate' command if you are using `makeinfo'. You only may need to use `Info-validate' if you are unable to run `makeinfo' and instead must create an Info file using `texinfo-format-region' or `texinfo-format-buffer', or if you write an Info file from scratch. * Menu: * Using Info-validate:: How to run `Info-validate'. * Unsplit:: How to create an unsplit file. * Tagifying:: How to tagify a file. * Splitting:: How to split a file manually. ways so helpful, and sometimes you must truly be a Sherlock Holmes to discover what went wrong. In any case, if you run into a problem like this, you can do one of three things. 1. You can tell TeX to continue running and ignore just this error by typing at the `?' prompt. 2. You can tell TeX to continue running and to ignore all errors as best it can by typing `r ' at the `?' prompt. This is often the best thing to do. H./info/texinfo-12 644 0 0 142020 7442531461 6761 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Using Info-validate, Next: Unsplit, Prev: Running Info-Validate, Up: Running Info-Validate Running `Info-validate' ----------------------- To use `Info-validate', visit the Info file you wish to check and type: M-x Info-validate Note that the `Info-validate' command requires an upper case `I'. You may also need to create a tag table before running `Info-validate'. *Note Tagifying::. If your file is valid, you will receive a message that says "File appears valid". However, if you have a pointer that does not point to a node, error messages will be displayed in a buffer called `*problems in info file*'. For example, `Info-validate' was run on a test file that contained only the first node of this manual. One of the messages said: In node "Overview", invalid Next: Texinfo Mode This meant that the node called `Overview' had a `Next' pointer that did not point to anything (which was true in this case, since the test file had only one node in it). Now suppose we add a node named `Texinfo Mode' to our test case but we do not specify a `Previous' for this node. Then we will get the following error message: In node "Texinfo Mode", should have Previous: Overview This is because every `Next' pointer should be matched by a `Previous' (in the node where the `Next' points) which points back. `Info-validate' also checks that all menu entries and cross references point to actual nodes. `Info-validate' requires a tag table and does not work with files that have been split. (The `texinfo-format-buffer' command automatically splits large files.) In order to use `Info-validate' on a large file, you must run `texinfo-format-buffer' with an argument so that it does not split the Info file; and you must create a tag table for the unsplit file.  File: texinfo, Node: Unsplit, Next: Tagifying, Prev: Using Info-validate, Up: Running Info-Validate Creating an Unsplit File ------------------------ You can run `Info-validate' only on a single Info file that has a tag table. The command will not work on the indirect subfiles that are generated when a master file is split. If you have a large file (longer than 70,000 bytes or so), you need to run the `texinfo-format-buffer' or `makeinfo-buffer' command in such a way that it does not create indirect subfiles. You will also need to create a tag table for the Info file. After you have done this, you can run `Info-validate' and look for badly referenced nodes. The first step is to create an unsplit Info file. To prevent `texinfo-format-buffer' from splitting a Texinfo file into smaller Info files, give a prefix to the `M-x texinfo-format-buffer' command: C-u M-x texinfo-format-buffer or else C-u C-c C-e C-b When you do this, Texinfo will not split the file and will not create a tag table for it.  File: texinfo, Node: Tagifying, Next: Splitting, Prev: Unsplit, Up: Running Info-Validate Tagifying a File ---------------- After creating an unsplit Info file, you must create a tag table for it. Visit the Info file you wish to tagify and type: M-x Info-tagify (Note the upper case `I' in `Info-tagify'.) This creates an Info file with a tag table that you can validate. The third step is to validate the Info file: M-x Info-validate (Note the upper case `I' in `Info-validate'.) In brief, the steps are: C-u M-x texinfo-format-buffer M-x Info-tagify M-x Info-validate After you have validated the node structure, you can rerun `texinfo-format-buffer' in the normal way so it will construct a tag table and split the file automatically, or you can make the tag table and split the file manually.  File: texinfo, Node: Splitting, Prev: Tagifying, Up: Running Info-Validate Splitting a File Manually ------------------------- You should split a large file or else let the `texinfo-format-buffer' or `makeinfo-buffer' command do it for you automatically. (Generally you will let one of the formatting commands do this job for you. *Note Creating an Info File::.) The split-off files are called the indirect subfiles. Info files are split to save memory. With smaller files, Emacs does not have make such a large buffer to hold the information. If an Info file has more than 30 nodes, you should also make a tag table for it. *Note Using Info-validate::, for information about creating a tag table. (Again, tag tables are usually created automatically by the formatting command; you only need to create a tag table yourself if you are doing the job manually. Most likely, you will do this for a large, unsplit file on which you have run `Info-validate'.) Visit the Info file you wish to tagify and split and type the two commands: M-x Info-tagify M-x Info-split (Note that the `I' in `Info' is upper case.) When you use the `Info-split' command, the buffer is modified into a (small) Info file which lists the indirect subfiles. This file should be saved in place of the original visited file. The indirect subfiles are written in the same directory the original file is in, with names generated by appending `-' and a number to the original file name. The primary file still functions as an Info file, but it contains just the tag table and a directory of subfiles.  File: texinfo, Node: Refilling Paragraphs, Next: Command Syntax, Prev: Catching Mistakes, Up: Top Refilling Paragraphs ******************** The `@refill' command refills and, optionally, indents the first line of a paragraph.(1) (*note Refilling Paragraphs-Footnote-1::) The `@refill' command is no longer important, but we describe it here because you once needed it. You will see it in many old Texinfo files. Without refilling, paragraphs containing long @-constructs may look bad after formatting because the formatter removes @-commands and shortens some lines more than others. In the past, neither the `texinfo-format-region' command nor the `texinfo-format-buffer' command refilled paragraphs automatically. The `@refill' command had to be written at the end of every paragraph to cause these formatters to fill them. (Both TeX and `makeinfo' have always refilled paragraphs automatically.) Now, all the Info formatters automatically fill and indent those paragraphs that need to be filled and indented. The `@refill' command causes `texinfo-format-region' and `texinfo-format-buffer' to refill a paragraph in the Info file _after_ all the other processing has been done. For this reason, you can not use `@refill' with a paragraph containing either `@*' or `@w{ ... }' since the refilling action will override those two commands. The `texinfo-format-region' and `texinfo-format-buffer' commands now automatically append `@refill' to the end of each paragraph that should be filled. They do not append `@refill' to the ends of paragraphs that contain `@*' or `@w{ ...}' and therefore do not refill or indent them.  File: texinfo, Node: Refilling Paragraphs-Footnotes, Up: Refilling Paragraphs (1) Perhaps the command should have been called the `@refillandindent' command, but `@refill' is shorter and the name was chosen before indenting was possible.  File: texinfo, Node: Command Syntax, Next: Obtaining TeX, Prev: Refilling Paragraphs, Up: Top @-Command Syntax **************** The character `@' is used to start special Texinfo commands. (It has the same meaning that `\' has in plain TeX.) Texinfo has four types of @-command: 1. Non-alphabetic commands. These commands consist of an @ followed by a punctuation mark or other character that is not part of the alphabet. Non-alphabetic commands are almost always part of the text within a paragraph, and never take any argument. The two characters (@ and the other one) are complete in themselves; none is followed by braces. The non-alphabetic commands are: `@.', `@:', `@*', `@SPACE', `@TAB', `@NL', `@@', `@{', and `@}'. 2. Alphabetic commands that do not require arguments. These commands start with @ followed by a word followed by left- and right-hand braces. These commands insert special symbols in the document; they do not require arguments. For example, `@dots{}' => `...', `@equiv{}' => `==', `@TeX{}' => `TeX', and `@bullet{}' => `*'. 3. Alphabetic commands that require arguments within braces. These commands start with @ followed by a letter or a word, followed by an argument within braces. For example, the command `@dfn' indicates the introductory or defining use of a term; it is used as follows: `In Texinfo, @@-commands are @dfn{mark-up} commands.' 4. Alphabetic commands that occupy an entire line. These commands occupy an entire line. The line starts with @, followed by the name of the command (a word); for example, `@center' or `@cindex'. If no argument is needed, the word is followed by the end of the line. If there is an argument, it is separated from the command name by a space. Braces are not used. Thus, the alphabetic commands fall into classes that have different argument syntaxes. You cannot tell to which class a command belongs by the appearance of its name, but you can tell by the command's meaning: if the command stands for a glyph, it is in class 2 and does not require an argument; if it makes sense to use the command together with other text as part of a paragraph, the command is in class 3 and must be followed by an argument in braces; otherwise, it is in class 4 and uses the rest of the line as its argument. The purpose of having a different syntax for commands of classes 3 and 4 is to make Texinfo files easier to read, and also to help the GNU Emacs paragraph and filling commands work properly. There is only one exception to this rule: the command `@refill', which is always used at the end of a paragraph immediately following the final period or other punctuation character. `@refill' takes no argument and does _not_ require braces. `@refill' never confuses the Emacs paragraph commands because it cannot appear at the beginning of a line.  File: texinfo, Node: Obtaining TeX, Next: Documentation Copying, Prev: Command Syntax, Up: Top How to Obtain TeX ***************** TeX is freely redistributable. You can obtain TeX for Unix systems via anonymous ftp or on physical media. The core material consists of the Web2c TeX distribution (`http://tug.org/web2c'). Instructions for retrieval by anonymous ftp and information on other available distributions: `ftp://tug.org/tex/unixtex.ftp' `http://tug.org/unixtex.ftp' The Free Software Foundation provides a core distribution on its Source Code CD-ROM suitable for printing Texinfo manuals. To order it, contact: Free Software Foundation, Inc. 59 Temple Place Suite 330 Boston, MA 02111-1307 USA Telephone: +1-617-542-5942 Fax: (including Japan) +1-617-542-2652 Free Dial Fax (in Japan): 0031-13-2473 (KDD) 0066-3382-0158 (IDC) Electronic mail: `gnu@gnu.org' Many other TeX distributions are available; see `http://tug.org/'.  File: texinfo, Node: Documentation Copying, Next: Command and Variable Index, Prev: Obtaining TeX, Up: Top GNU Free Documentation License ****************************** Version 1.1, March 2000 Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 0. PREAMBLE The purpose of this License is to make a manual, textbook, or other written document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. 1. APPLICABILITY AND DEFINITIONS This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (For example, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, whose contents can be viewed and edited directly and straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup has been designed to thwart or discourage subsequent modification by readers is not Transparent. A copy that is not "Transparent" is called "Opaque". Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML designed for human modification. Opaque formats include PostScript, PDF, proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML produced by some word processors for output purposes only. The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text. 2. VERBATIM COPYING You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. You may also lend copies, under the same conditions stated above, and you may publicly display copies. 3. COPYING IN QUANTITY If you publish printed copies of the Document numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a publicly-accessible computer-network location containing a complete Transparent copy of the Document, free of added material, which the general network-using public has access to download anonymously at no charge using public-standard network protocols. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. 4. MODIFICATIONS You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has less than five). C. State on the Title page the name of the publisher of the Modified Version, as the publisher. D. Preserve all the copyright notices of the Document. E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice. H. Include an unaltered copy of this License. I. Preserve the section entitled "History", and its title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission. K. In any section entitled "Acknowledgments" or "Dedications", preserve the section's title, and preserve in the section all the substance and tone of each of the contributor acknowledgments and/or dedications given therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. M. Delete any section entitled "Endorsements". Such a section may not be included in the Modified Version. N. Do not retitle any existing section as "Endorsements" or to conflict in title with any Invariant Section. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles. You may add a section entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections entitled "History" in the various original documents, forming one section entitled "History"; likewise combine any sections entitled "Acknowledgments", and any sections entitled "Dedications". You must delete all sections entitled "Endorsements." 6. COLLECTIONS OF DOCUMENTS You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. 7. AGGREGATION WITH INDEPENDENT WORKS A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, does not as a whole count as a Modified Version of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is called an "aggregate", and this License does not apply to the other self-contained works thus compiled with the Document, on account of their being thus compiled, if they are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one quarter of the entire aggregate, the Document's Cover Texts may be placed on covers that surround only the Document within the aggregate. Otherwise they must appear on covers around the whole aggregate. 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License provided that you also include the original English version of this License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail. 9. TERMINATION You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 10. FUTURE REVISIONS OF THIS LICENSE The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See `http://www.gnu.org/copyleft/'. Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. ADDENDUM: How to use this License for your documents ---------------------------------------------------- To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: Copyright (C) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. A copy of the license is included in the section entitled ``GNU Free Documentation License''. If you have no Invariant Sections, write "with no Invariant Sections" instead of saying which ones are invariant. If you have no Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.  File: texinfo, Node: Command and Variable Index, Next: Concept Index, Prev: Documentation Copying, Up: Top Command and Variable Index ************************** This is an alphabetical list of all the @-commands, assorted Emacs Lisp functions, and several variables. To make the list easier to use, the commands are listed without their preceding `@'. * Menu: * ! (end of sentence): Ending a Sentence. * ": Inserting Accents. * ': Inserting Accents. * (newline): Multiple Spaces. * (space): Multiple Spaces. * (tab): Multiple Spaces. * * (force line break): Line Breaks. * ,: Inserting Accents. * -: - and hyphenation. * . (end of sentence): Ending a Sentence. * (suppress widening): Not Ending a Sentence. * =: Inserting Accents. * ? (end of sentence): Ending a Sentence. * @ (single @): Inserting An Atsign. * \emergencystretch: Overfull hboxes. * ^: Inserting Accents. * `: Inserting Accents. * AA: Inserting Accents. * aa: Inserting Accents. * acronym: acronym. * AE: Inserting Accents. * ae: Inserting Accents. * afourlatex: A4 Paper. * afourpaper: A4 Paper. * afourwide: A4 Paper. * alias: alias. * anchor: anchor. * appendix: unnumbered & appendix. * appendixsec: unnumberedsec appendixsec heading. * appendixsection: unnumberedsec appendixsec heading. * appendixsubsec: unnumberedsubsec appendixsubsec subheading. * appendixsubsubsec: subsubsection. * apply: Sample Function Definition. * asis: table. * author: title subtitle author. * b (bold font): Fonts. * buffer-end: Def Cmd Template. * bullet: bullet. * bye <1>: Ending a File. * bye: File End. * c (comment): Comments. * cartouche: cartouche. * center: titlefont center sp. * centerchap: chapter. * chapheading: majorheading & chapheading. * chapter: chapter. * cindex: Indexing Commands. * cite: cite. * code: code. * columnfractions: Multitable Column Widths. * command: command. * comment: Comments. * contents: Contents. * copyright <1>: copyright symbol. * copyright: Copyright & Permissions. * cropmarks: Cropmarks and Magnification. * defcodeindex: New Indices. * defcv: Abstract Objects. * deffn: Functions Commands. * deffnx: deffnx. * defindex: New Indices. * definfoenclose: definfoenclose. * defivar: Abstract Objects. * defmac: Functions Commands. * defmethod: Abstract Objects. * defop: Abstract Objects. * defopt: Variables Commands. * defspec: Functions Commands. * deftp: Data Types. * deftypefn: Typed Functions. * deftypefun: Typed Functions. * deftypeivar: Abstract Objects. * deftypeop: Abstract Objects. * deftypevar: Typed Variables. * deftypevr: Typed Variables. * defun: Functions Commands. * defvar: Variables Commands. * defvr: Variables Commands. * Development/Docs/Texinfo Customize group: Texinfo Mode Printing. * dfn: dfn. * dircategory: Installing Dir Entries. * direntry: Installing Dir Entries. * display: display. * dmn: dmn. * documentdescription: documentdescription. * documentencoding: documentencoding. * documentlanguage: documentlanguage. * dotaccent: Inserting Accents. * dotless: Inserting Accents. * dots: dots. * email: email. * emph: emph & strong. * end <1>: Introducing Lists. * end: Quotations and Examples. * end titlepage: end titlepage. * enddots: dots. * enumerate: enumerate. * env: env. * equiv: Equivalence. * error: Error Glyph. * evenfooting: Custom Headings. * evenheading: Custom Headings. * everyfooting: Custom Headings. * everyheading: Custom Headings. * example: example. * exampleindent: exampleindent. * exclamdown: Inserting Accents. * exdent: exdent. * expansion: expansion. * file: file. * filll: Copyright & Permissions. * finalout: Overfull hboxes. * findex: Indexing Commands. * flushleft: flushleft & flushright. * flushright: flushleft & flushright. * foobar: Optional Arguments. * footnote: Footnotes. * footnotestyle: Footnote Styles. * format: format. * forward-word: Def Cmd Template. * ftable: ftable vtable. * group: group. * H: Inserting Accents. * hbox: Overfull hboxes. * heading: unnumberedsec appendixsec heading. * headings: headings on off. * headword: definfoenclose. * html: Raw Formatter Commands. * hyphenation: - and hyphenation. * i (italic font): Fonts. * ifclear: ifset ifclear. * ifhtml <1>: Conditional Commands. * ifhtml: Raw Formatter Commands. * ifinfo: Conditional Commands. * ifnothtml: Conditional Not Commands. * ifnotinfo: Conditional Not Commands. * ifnottex: Conditional Not Commands. * ifset: ifset ifclear. * iftex: Conditional Commands. * ignore: Comments. * image: Images. * include: Using Include Files. * Info-validate: Running Info-Validate. * inforef: inforef. * input (TeX command): Minimum. * isearch-backward: deffnx. * isearch-forward: deffnx. * item <1>: itemize. * item <2>: table. * item: Multitable Rows. * itemize: itemize. * itemx: itemx. * kbd: kbd. * kbdinputstyle: kbd. * key: key. * kindex: Indexing Commands. * L: Inserting Accents. * l: Inserting Accents. * lisp: lisp. * lowersections: Raise/lower sections. * macro: Defining Macros. * mag (TeX command): Cropmarks and Magnification. * majorheading: majorheading & chapheading. * makeinfo-buffer: makeinfo in Emacs. * makeinfo-kill-job: makeinfo in Emacs. * makeinfo-recenter-output-buffer: makeinfo in Emacs. * makeinfo-region: makeinfo in Emacs. * math: math. * menu: Menus. * minus: minus. * multitable: Multi-column Tables. * need: need. * next-error: makeinfo in Emacs. * node: node. * noindent: noindent. * novalidate: Format with tex/texindex. * O: Inserting Accents. * o: Inserting Accents. * occur: Using occur. * occur-mode-goto-occurrence: Showing the Structure. * oddfooting: Custom Headings. * oddheading: Custom Headings. * oe: Inserting Accents. * OE: Inserting Accents. * option: option. * page: page. * page, within @titlepage: titlepage. * pagesizes: pagesizes. * paragraphindent: paragraphindent. * phoo: definfoenclose. * pindex: Indexing Commands. * point: Point Glyph. * pounds: pounds. * print: Print Glyph. * printindex: Printing Indices & Menus. * pxref: pxref. * questiondown: Inserting Accents. * quotation: quotation. * r (Roman font): Fonts. * raisesections: Raise/lower sections. * ref: ref. * refill: Refilling Paragraphs. * result: result. * ringaccent: Inserting Accents. * rmacro: Defining Macros. * samp: samp. * sc (small caps font): Smallcaps. * section: section. * setchapternewpage: setchapternewpage. * setcontentsaftertitlepage: Contents. * setfilename: setfilename. * setshortcontentsaftertitlepage: Contents. * settitle: settitle. * shortcontents: Contents. * shorttitlepage: titlepage. * smallbook: smallbook. * smalldisplay <1>: display. * smalldisplay: small. * smallexample: small. * smallformat <1>: small. * smallformat: format. * smalllisp: small. * sp (line spacing): sp. * sp (titlepage line spacing): titlefont center sp. * ss: Inserting Accents. * strong: emph & strong. * subheading: unnumberedsubsec appendixsubsec subheading. * subsection: subsection. * subsubheading: subsubsection. * subsubsection: subsubsection. * subtitle: title subtitle author. * summarycontents: Contents. * syncodeindex: syncodeindex. * synindex: synindex. * t (typewriter font): Fonts. * tab: Multitable Rows. * table: Two-column Tables. * tex: Raw Formatter Commands. * tex (command): tex. * texinfo-all-menus-update: Updating Commands. * texinfo-every-node-update: Updating Commands. * texinfo-format-buffer <1>: Info Formatting. * texinfo-format-buffer: texinfo-format commands. * texinfo-format-region <1>: Info Formatting. * texinfo-format-region: texinfo-format commands. * texinfo-indent-menu-description: Other Updating Commands. * texinfo-insert-@code: Inserting. * texinfo-insert-@dfn: Inserting. * texinfo-insert-@end: Inserting. * texinfo-insert-@example: Inserting. * texinfo-insert-@item: Inserting. * texinfo-insert-@kbd: Inserting. * texinfo-insert-@node: Inserting. * texinfo-insert-@noindent: Inserting. * texinfo-insert-@samp: Inserting. * texinfo-insert-@table: Inserting. * texinfo-insert-@var: Inserting. * texinfo-insert-braces: Inserting. * texinfo-insert-node-lines: Other Updating Commands. * texinfo-make-menu: Updating Commands. * texinfo-master-menu: Updating Commands. * texinfo-multiple-files-update: texinfo-multiple-files-update. * texinfo-multiple-files-update (in brief): Other Updating Commands. * texinfo-sequential-node-update: Other Updating Commands. * texinfo-show-structure <1>: Showing the Structure. * texinfo-show-structure: Using texinfo-show-structure. * texinfo-start-menu-description: Inserting. * texinfo-tex-buffer: Printing. * texinfo-tex-print: Printing. * texinfo-tex-region: Printing. * texinfo-update-node: Updating Commands. * thischapter: Custom Headings. * thischaptername: Custom Headings. * thisfile: Custom Headings. * thispage: Custom Headings. * thistitle: Custom Headings. * tieaccent: Inserting Accents. * tindex: Indexing Commands. * title: title subtitle author. * titlefont: titlefont center sp. * titlepage: titlepage. * today: Custom Headings. * top (@-command): makeinfo top command. * u: Inserting Accents. * ubaraccent: Inserting Accents. * udotaccent: Inserting Accents. * unmacro: Defining Macros. * unnumbered: unnumbered & appendix. * unnumberedsec: unnumberedsec appendixsec heading. * unnumberedsubsec: unnumberedsubsec appendixsubsec subheading. * unnumberedsubsubsec: subsubsection. * up-list: Inserting. * uref: uref. * url: url. * v: Inserting Accents. * value: set value. * var: var. * verb: verb. * verbatim: verbatim. * verbatiminclude: verbatiminclude. * vindex: Indexing Commands. * vskip: Copyright & Permissions. * vtable: ftable vtable. * w (prevent line break): w. * xref: xref. * { (single {): Inserting Braces. * } (single }): Inserting Braces. * ~: Inserting Accents. majorheading & chapheading. * makeinfo-buffer: makeinfo in Emacs. * makeinfo-kill-job: makeinfo in Emacs. * makeinfo-recenter-output-buffer: makeinfo in Emacs. * makeinfo-region: makeinfo in Emacs. * math: math. * menu: Menus. * minus: minus. * multitable: Multi-column Tables. * need: ./info/texinfo-13 644 0 0 131574 7442531461 6776 This is texinfo, produced by makeinfo version 4.1 from texinfo.txi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce both online information and a printed manual from a single source. This edition is for Texinfo version 4.1, 4 March 2002. Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Section being "History", with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: texinfo, Node: Concept Index, Prev: Command and Variable Index, Up: Top Concept Index ************* * Menu: * !: Inserting Accents. * Œ: Inserting Accents. * œ: Inserting Accents. * (dir) as Up node of Top node: First Node. * --commands-in-node-names: makeinfo options. * --delete: Invoking install-info. * --dir-file=NAME: Invoking install-info. * --docbook: makeinfo options. * --entry=TEXT: Invoking install-info. * --error-limit=LIMIT: makeinfo options. * --fill-column=WIDTH: makeinfo options. * --footnote-style=STYLE: makeinfo options. * --force: makeinfo options. * --help <1>: makeinfo options. * --help: Invoking install-info. * --html: makeinfo options. * --info-dir=DIR: Invoking install-info. * --info-file=FILE: Invoking install-info. * --item=TEXT: Invoking install-info. * --no-headers: makeinfo options. * --no-number-footnotes: makeinfo options. * --no-pointer-validate: makeinfo options. * --no-split: makeinfo options. * --no-validate: makeinfo options. * --no-warn: makeinfo options. * --number-sections: makeinfo options. * --output=FILE: makeinfo options. * --paragraph-indent=INDENT: makeinfo options. * --quiet: Invoking install-info. * --reference-limit=LIMIT: makeinfo options. * --remove: Invoking install-info. * --section=SEC: Invoking install-info. * --verbose: makeinfo options. * --version <1>: makeinfo options. * --version: Invoking install-info. * --xml: makeinfo options. * -D DIR: Invoking install-info. * -d NAME: Invoking install-info. * -D VAR: makeinfo options. * -e LIMIT: makeinfo options. * -e TEXT: Invoking install-info. * -F: makeinfo options. * -f WIDTH: makeinfo options. * -h <1>: makeinfo options. * -h: Invoking install-info. * -I DIR: makeinfo options. * -i FILE: Invoking install-info. * -o FILE: makeinfo options. * -P DIR: makeinfo options. * -p INDENT: makeinfo options. * -r: Invoking install-info. * -r LIMIT: makeinfo options. * -s SEC: Invoking install-info. * -s STYLE: makeinfo options. * -V <1>: makeinfo options. * -V: Invoking install-info. * .cshrc initialization file: Preparing for TeX. * .profile initialization file: Preparing for TeX. * /L: Inserting Accents. * /l: Inserting Accents. * /o: Inserting Accents. * /O: Inserting Accents. * HTML tag, and document description: documentdescription. * : Dots Bullets. * Dots, inserting: dots. * Double-colon menu entries: Less Cluttered Menu Entry. * Dumping a .fmt file: Preparing for TeX. * DVI file: Format with tex/texindex. * Ellipsis, inserting: Dots Bullets. * em-dash: minus. * Emacs: Texinfo Mode. * Emacs shell, format, print from: Within Emacs. * Emphasizing text: Emphasis. * Emphasizing text, font for: emph & strong. * Encoding, declaring: documentencoding. * End node footnote style: Footnote Styles. * End of header line: End of Header. * End titlepage starts headings: end titlepage. * Ending a Sentence: Ending a Sentence. * Ending a Texinfo file: Ending a File. * Entries for an index: Indexing Commands. * Entries, making index: Index Entries. * Enumeration: enumerate. * Environment indentation: exampleindent. * epsf.tex: Images. * epsf.tex, installing: Preparing for TeX. * Equations, displayed: math. * Equivalence, indicating it: Equivalence. * Error message, indicating it: Error Glyph. * Errors, parsing: makeinfo in Emacs. * Es-zet: Inserting Accents. * European A4 paper: A4 Paper. * Evaluation glyph: result. * Example indentation: exampleindent. * Example menu: Menu Example. * example, arg to @kbdinputstyle: kbd. * Examples in smaller fonts: small. * Examples, formatting them: example. * Examples, glyphs for: Glyphs. * Expanding macros: Invoking Macros. * Expansion, indicating it: expansion. * Expressions in a program, indicating: code. * F.B.I., as acronym: acronym. * FDL, GNU Free Documentation License: Documentation Copying. * File beginning: Beginning a File. * File ending: Ending a File. * File section structure, showing it: Showing the Structure. * Filling paragraphs: Refilling Paragraphs. * Final output: Overfull hboxes. * Finding badly referenced nodes: Running Info-Validate. * Fine-tuning, and hyphenation: - and hyphenation. * First line of a Texinfo file: First Line. * First node: First Node. * Floating accents, inserting: Inserting Accents. * Flooding: pxref. * Fonts for indices: syncodeindex. * Fonts for printing, not for Info: Fonts. * Footings: Headings. * Footnotes: Footnotes. * Format a dimension: dmn. * Format and print hardcopy: Hardcopy. * Format and print in Texinfo mode: Texinfo Mode Printing. * Format file, dumping: Preparing for TeX. * Format with the compile command: Compile-Command. * Format, print from Emacs shell: Within Emacs. * Formats for images: Images. * Formatting a file for Info: Creating an Info File. * Formatting commands: Formatting Commands. * Formatting examples: example. * Formatting for Info: Info Formatting. * Formatting for printing: Printing. * Formatting headings and footings: Headings. * Formatting requirements: Requirements Summary. * Formatting with tex and texindex: Format with tex/texindex. * Formulas, mathematical: math. * Frequently used commands, inserting: Inserting. * Function definitions: Sample Function Definition. * General syntactic conventions: Conventions. * Generating menus with indices: Printing Indices & Menus. * Generating plain text files: makeinfo options. * German S: Inserting Accents. * GIF, unsupported due to patents: Images. * Globbing: Format with tex/texindex. * Glyphs: Glyphs. * GNU Emacs: Texinfo Mode. * GNU Emacs shell, format, print from: Within Emacs. * Going to other Info files' nodes: Other Info Files. * Grave accent: Inserting Accents. * Group (hold text together vertically): group. * Grouping two definitions together: deffnx. * Hardcopy, printing it: Hardcopy. * hboxes, overfull: Overfull hboxes. * Header for Texinfo files: Header. * Header of a Texinfo file: First Line. * Headings: Headings. * Headings, page, begin to appear: end titlepage. * Height of images: Images. * Height of text area: pagesizes. * help2man: Using Texinfo. * Highlighting text: Indicating. * Highlighting, customized: definfoenclose. * Hints: Tips. * History of Texinfo: History. * Holding text together vertically: group. * href, producing HTML: uref. * HTML: makeinfo html. * HTML commands, using ordinary: Raw Formatter Commands. * http-equiv, and charset: documentencoding. * Hungarian umlaut accent: Inserting Accents. * Hurricanes: ref. * hyphen: minus. * Hyphenation patterns, language-dependent: documentlanguage. * Hyphenation, helping TeX do: - and hyphenation. * Hyphenation, preventing: w. * i: Inserting Accents. * If text conditionally visible: Conditionals. * Ignored before @setfilename: setfilename. * Ignored text: Comments. * Image formats: Images. * Images, inserting: Images. * Inches: Images. * Include file requirements: Include File Requirements. * Include file sample: Sample Include File. * Include files: Include Files. * Include files, and section levels: Raise/lower sections. * Including a file verbatim: verbatiminclude. * Indentation undoing: exdent. * Indenting environments: exampleindent. * Indenting paragraphs: paragraphindent. * Index entries: Indexing Commands. * Index entries, making: Index Entries. * Index entry writing: Indexing Commands. * Index file names: Format with tex/texindex. * Index font types: Indexing Commands. * Indexing commands, predefined: Indexing Commands. * Indexing table entries automatically: ftable vtable. * Indicating commands, definitions, etc.: Indicating. * Indicating evaluation: result. * Indices: Indices. * Indices, combining them: Combining Indices. * Indices, defining new: New Indices. * Indices, printing and menus: Printing Indices & Menus. * Indices, sorting: Hardcopy. * Indices, two letter names: syncodeindex. * Indirect subfiles: Tag and Split Files. * Info batch formatting: Batch Formatting. * Info file installation: Installing an Info File. * Info file requires @setfilename: setfilename. * Info file, listing a new: New Info File. * Info file, splitting manually: Splitting. * Info files: Info Files. * Info formatting: Info Formatting. * Info installed in another directory: Other Info Directories. * Info validating a large file: Using Info-validate. * Info, creating an online file: Creating an Info File. * Info-directory-list: Other Info Directories. * Info; other files' nodes: Other Info Files. * INFOPATH: Other Info Directories. * Initialization file for TeX input: Preparing for TeX. * Input encoding, declaring: documentencoding. * Insert nodes, menus automatically: Updating Nodes and Menus. * Inserting @, braces: Braces Atsigns. * Inserting accents: Inserting Accents. * Inserting dots <1>: dots. * Inserting dots: Dots Bullets. * Inserting ellipsis: Dots Bullets. * Inserting frequently used commands: Inserting. * Inserting space: Inserting Space. * Inserting special characters and symbols: Insertions. * INSTALL file, generating: makeinfo options. * install-info: Invoking install-info. * Installing an Info file: Installing an Info File. * Installing Info in another directory: Other Info Directories. * Internationalization: Internationalization. * Introduction to Texinfo: Using Texinfo. * Introduction, as part of file: Software Copying Permissions. * Invalid characters in node names: Node Line Requirements. * Invoking macros: Invoking Macros. * ISO 639 codes: documentlanguage. * Itemization: itemize. * j: Inserting Accents. * JPG image format: Images. * Keyboard input: kbd. * Keys, recommended names: key. * Keywords, indicating: code. * Knuth, Donald: Printed Books. * Language codes: documentlanguage. * Language, declaring: documentlanguage. * Larger or smaller pages: Cropmarks and Magnification. * Legal paper, printing on: pagesizes. * Less cluttered menu entry: Less Cluttered Menu Entry. * License agreement: Software Copying Permissions. * Line breaks <1>: Line Breaks. * Line breaks: Breaks. * Line breaks, preventing: w. * Line length, column widths as fraction of: Multitable Column Widths. * Line spacing: sp. * Lisp example: lisp. * Lisp examples in smaller fonts: small. * List of @-commands: Command List. * Listing a new Info file: New Info File. * Lists and tables, making: Lists and Tables. * Local variables: Compile-Command. * Location of menus: Menu Location. * Looking for badly referenced nodes: Running Info-Validate. * lpr (DVI print command): Print with lpr. * lpr-d, replacements on MS-DOS/MS-Windows: Print with lpr. * Macro definitions <1>: Sample Function Definition. * Macro definitions: Defining Macros. * Macro details: Macro Details. * Macro invocation: Invoking Macros. * Macron accent: Inserting Accents. * Macros: Defining New Texinfo Commands. * Macros in definition commands: Def Cmd Template. * Macros, undefining: Defining Macros. * Magnified printing: Cropmarks and Magnification. * mailto link: email. * makeinfo: Using Texinfo. * makeinfo inside Emacs: makeinfo in Emacs. * makeinfo options: makeinfo options. * Making a printed manual: Hardcopy. * Making a tag table automatically: Tag and Split Files. * Making a tag table manually: Unsplit. * Making cross references: Cross References. * Making line and page breaks: Breaks. * Making lists and tables: Lists and Tables. * Man page output, not supported: Using Texinfo. * Man page, reference to: uref. * Manual characteristics, printed: Printed Books. * Margins on page, not controllable: pagesizes. * Marking text within a paragraph: Marking Text. * Marking words and phrases: Marking Text. * Master menu: The Top Node. * Master menu parts: Master Menu Parts. * Mathematical expressions <1>: Raw Formatter Commands. * Mathematical expressions: math. * Menu description, start: Inserting. * Menu entries with two colons: Less Cluttered Menu Entry. * Menu example: Menu Example. * Menu location: Menu Location. * Menu parts: Menu Parts. * Menu writing: Writing a Menu. * Menus: Menus. * Menus generated with indices: Printing Indices & Menus. * meta HTML tag, and charset: documentencoding. * META key: key. * Meta-syntactic chars for arguments: Optional Arguments. * Millimeters: Images. * Minimal requirements for formatting: Requirements Summary. * Minimal Texinfo file (requirements): Minimum. * Mistakes, catching: Catching Mistakes. * Mode, using Texinfo: Texinfo Mode. * Multiple spaces: Multiple Spaces. * Multitable column widths: Multitable Column Widths. * Multitable rows: Multitable Rows. * Must have in Texinfo file: Minimum. * Mutually recursive macros: Defining Macros. * Names for indices: syncodeindex. * Names of index files: Format with tex/texindex. * Names recommended for keys: key. * Naming a `Top' Node in references: Top Node Naming. * NASA, as acronym: acronym. * Navigation links, omitting: makeinfo options. * Need space at page bottom: need. * New index defining: New Indices. * New Info file, listing it in dir file: New Info File. * New Texinfo commands, defining: Defining New Texinfo Commands. * Node line requirements: Node Line Requirements. * Node line writing: Writing a Node. * Node name must be unique: Node Line Requirements. * Node name, should not contain @-commands: Node Line Requirements. * Node names, choosing: Node Names. * Node, `Top': The Top Node. * Node, defined: node. * Nodes for menus are short: Menu Location. * Nodes in other Info files: Other Info Files. * Nodes, catching mistakes: Catching Mistakes. * Nodes, checking for badly referenced: Running Info-Validate. * Non-breakable space: w. * Not ending a sentence: Not Ending a Sentence. * O'Dea, Brendan: Using Texinfo. * Obtaining TeX: Obtaining TeX. * Occurrences, listing with @occur: Using occur. * Optional and repeated arguments: Optional Arguments. * Options for makeinfo: makeinfo options. * Ordinary HTML commands, using: Raw Formatter Commands. * Ordinary TeX commands, using: Raw Formatter Commands. * Other Info files' nodes: Other Info Files. * Outline of file structure, showing it: Showing the Structure. * Output file splitting: makeinfo options. * Output formats, supporting more: Using Texinfo. * Overfull hboxes: Overfull hboxes. * Overview of Texinfo: Overview. * Page breaks <1>: page. * Page breaks: Breaks. * Page delimiter in Texinfo mode: Showing the Structure. * Page headings: Headings. * Page numbering: Headings. * Page sizes for books: smallbook. * Page sizes, customized: pagesizes. * page-delimiter: Showing the Structure. * Pages, starting odd: setchapternewpage. * Paper size, A4: A4 Paper. * Paragraph indentation: paragraphindent. * Paragraph, marking text within: Marking Text. * Paragraphs, filling: Refilling Paragraphs. * Parameters to macros: Defining Macros. * Parentheses in nodename: Node Line Requirements. * Parsing errors: makeinfo in Emacs. * Part of file formatting and printing: Printing. * Parts of a cross reference: Cross Reference Parts. * Parts of a master menu: Master Menu Parts. * Parts of a menu: Menu Parts. * PDF output: PDF Output. * pdfcolor.tex, installing: Preparing for TeX. * pdftex: PDF Output. * pdftex, and images: Images. * Period in nodename: Node Line Requirements. * Periods, inserting: Not Ending a Sentence. * Permissions, printed: Copyright & Permissions. * Picas: Images. * Pictures, inserting: Images. * Pinard, Franc,ois: History. * plain TeX: Raw Formatter Commands. * Plain text output: makeinfo options. * PNG image format: Images. * Point, indicating in a buffer: Point Glyph. * Pointer creation with makeinfo: makeinfo Pointer Creation. * Pointer validation with makeinfo: Pointer Validation. * Pointer validation, suppressing <1>: makeinfo options. * Pointer validation, suppressing: Format with tex/texindex. * Points (dimension): Images. * Predefined indexing commands: Indexing Commands. * Predefined names for indices: syncodeindex. * Preparing for TeX: Preparing for TeX. * Preventing line and page breaks: Breaks. * Previous node of Top node: First Node. * Print and format in Texinfo mode: Texinfo Mode Printing. * Print, format from Emacs shell: Within Emacs. * Printed book and manual characteristics: Printed Books. * Printed output, indicating it: Print Glyph. * Printed permissions: Copyright & Permissions. * Printing a region or buffer: Printing. * Printing an index: Printing Indices & Menus. * Printing cropmarks: Cropmarks and Magnification. * Printing DVI files, on MS-DOS/MS-Windows: Print with lpr. * Printing hardcopy: Hardcopy. * Problems, catching: Catching Mistakes. * Program names, indicating: command. * Prototype row, column widths defined by: Multitable Column Widths. * Quotations: quotation. * ragged left: flushleft & flushright. * ragged right: flushleft & flushright. * Raising and lowering sections: Raise/lower sections. * Raw formatter commands: Raw Formatter Commands. * Recommended names for keys: key. * Rectangle, black in hardcopy: Overfull hboxes. * Recursion, mutual: Defining Macros. * Recursive macro invocations: Defining Macros. * Reference to @-commands: Command List. * References: Cross References. * References using @inforef: inforef. * References using @pxref: pxref. * References using @ref: ref. * References using @xref: xref. * Referring to other Info files: Other Info Files. * Refilling paragraphs: Refilling Paragraphs. * Region formatting and printing: Printing. * Region printing in Texinfo mode: Texinfo Mode Printing. * Reid, Brian: History. * Repeated and optional arguments: Optional Arguments. * Reporting bugs: Reporting Bugs. * Required in Texinfo file: Minimum. * Requirements for formatting: Requirements Summary. * Requirements for include files: Include File Requirements. * Requirements for updating commands: Updating Requirements. * Reserved words, indicating: code. * Restrictions on node names: Node Line Requirements. * Result of an expression: result. * ridt.eps: Images. * Ring accent: Inserting Accents. * Rounded rectangles, around examples: cartouche. * Rows, of a multitable: Multitable Rows. * Running an Info formatter: Info Formatting. * Running Info-validate: Using Info-validate. * Running macros: Invoking Macros. * Running makeinfo in Emacs: makeinfo in Emacs. * Sample @include file: Sample Include File. * Sample function definition: Sample Function Definition. * Sample Texinfo file: Short Sample. * Sample Texinfo file, no comments: Sample Texinfo File. * Scaled points: Images. * Schwab, Andreas: History. * Scribe: History. * Sea surges: ref. * Section structure of a file, showing it: Showing the Structure. * Sections, raising and lowering: Raise/lower sections. * Sentence ending punctuation: Ending a Sentence. * Sentence non-ending punctuation: Not Ending a Sentence. * Separate footnote style: Footnote Styles. * SGML-tools output format: Using Texinfo. * Sharp S: Inserting Accents. * Shell formatting with tex and texindex: Format with tex/texindex. * Shell printing, on MS-DOS/MS-Windows: Print with lpr. * Shell, format, print from: Within Emacs. * Shell, running makeinfo in: makeinfo in Emacs. * Short nodes for menus: Menu Location. * Short table of contents: Contents. * Showing the section structure of a file: Showing the Structure. * Showing the structure of a file: Using texinfo-show-structure. * shrubbery: ifset ifclear. * Site-wide Texinfo configuration file: Preparing for TeX. * Size of printed book: smallbook. * slanted typewriter font, for @kbd: kbd. * Small book size: smallbook. * Small caps font: Smallcaps. * Small examples: small. * Software copying permissions: Software Copying Permissions. * Sorting indices: Hardcopy. * Source file: Using Texinfo. * Space, inserting horizontal: Multiple Spaces. * Space, inserting vertical: sp. * Spaces in macros: Defining Macros. * Spaces, in menus: Writing a Menu. * Spacing, inserting: Inserting Space. * Special characters, commands to insert: Braces Atsigns. * Special insertions: Insertions. * Special typesetting commands: Dots Bullets. * Specifying index entries: Indexing Commands. * Splitting an Info file manually: Splitting. * Splitting of output files: makeinfo options. * ss: Inserting Accents. * Stallman, Richard M.: History. * Start of header line: Start of Header. * Starting chapters: setchapternewpage. * Structure of a file, showing it: Showing the Structure. * Structure, catching mistakes in: Catching Mistakes. * Structuring of chapters: Structuring. * Subsection-like commands: unnumberedsubsec appendixsubsec subheading. * Subsub commands: subsubsection. * Suggestions for Texinfo, making: Reporting Bugs. * Summary of document: documentdescription. * Syntactic conventions: Conventions. * Syntactic tokens, indicating: code. * Syntax, of @-commands: Command Syntax. * Syntax, optional & repeated arguments: Optional Arguments. * Table of contents: Contents. * Table of contents, after title page: Contents. * Tables and lists, making: Lists and Tables. * Tables with indexes: ftable vtable. * Tables, making multi-column: Multi-column Tables. * Tables, making two-column: Two-column Tables. * Tabs; don't use!: Conventions. * Tag table, making automatically: Tag and Split Files. * Tag table, making manually: Unsplit. * Targets for cross-references, arbitrary: anchor. * Template for a definition: Def Cmd Template. * TeX commands, using ordinary: Raw Formatter Commands. * TeX index sorting: Hardcopy. * TeX input initialization: Preparing for TeX. * TeX, how to obtain: Obtaining TeX. * texi2dvi: Format with tex/texindex. * texi2dvi (shell script): Format with texi2dvi. * texi2roff, unsupported software: Printed Books. * texindex <1>: Format with tex/texindex. * texindex: Hardcopy. * Texinfo commands, defining new: Defining New Texinfo Commands. * Texinfo file beginning: Beginning a File. * Texinfo file ending: Ending a File. * Texinfo file header: Header. * Texinfo file minimum: Minimum. * Texinfo file section structure, showing it: Showing the Structure. * Texinfo mode: Texinfo Mode. * Texinfo overview: Overview. * Texinfo printed book characteristics: Printed Books. * Texinfo, introduction to: Using Texinfo. * texinfo.cnf: setfilename. * texinfo.cnf installation: Preparing for TeX. * texinfo.tex, installing: Preparing for TeX. * TEXINPUTS: Preparing for TeX. * TEXINPUTS environment variable: Preparing for TeX. * Text width and height: pagesizes. * Text, conditionally visible: Conditionals. * Text, marking up: Marking Text. * Thin space between number, dimension: dmn. * Tie-after accent: Inserting Accents. * Tied space: w. * Tilde accent: Inserting Accents. * Tips: Tips. * Title page: titlepage. * Title page, bastard: titlepage. * Titlepage end starts headings: end titlepage. * Titlepage, for plain text: Titlepage & Copyright Page. * Top node: The Top Node. * Top node is first: First Node. * Top node naming for references: Top Node Naming. * Top node summary: Top Node Summary. * Tree structuring: Tree Structuring. * Two `First' Lines for @deffn: deffnx. * Two letter names for indices: syncodeindex. * Two named items for @table: itemx. * Two part menu entry: Less Cluttered Menu Entry. * txi-CC.tex: documentlanguage. * Typesetting commands for dots, etc.: Dots Bullets. * Ugly black rectangles in hardcopy: Overfull hboxes. * Umlaut accent: Inserting Accents. * Unbreakable space: w. * Uncluttered menu entry: Less Cluttered Menu Entry. * Undefining macros: Defining Macros. * Underbar accent: Inserting Accents. * Underdot accent: Inserting Accents. * Uniform resource locator, indicating: url. * Uniform resource locator, referring to: uref. * Unique nodename requirement: Node Line Requirements. * Unprocessed text: Comments. * Unsplit file creation: Unsplit. * Up node of Top node: First Node. * Updating nodes and menus: Updating Nodes and Menus. * Updating requirements: Updating Requirements. * URI syntax for Info: Info Files. * URL, indicating: url. * URL, referring to: uref. * Usage tips: Tips. * user input: kbd. * User options, marking: Variables Commands. * User-defined Texinfo commands: Defining New Texinfo Commands. * Using Texinfo in general: Using Texinfo. * Validating a large file: Using Info-validate. * Validation of pointers: Pointer Validation. * Value of an expression, indicating: result. * Verbatim environment: verbatim. * Verbatim in-line text: verb. * Verbatim, include file: verbatiminclude. * version number, finding: Invoking install-info. * Vertical whitespace (vskip): Copyright & Permissions. * Vertically holding text together: group. * Visibility of conditional text: Conditionals. * Weinberg, Zack: History. * Weisshaus, Melissa: History. * White space, excessive: Breaks. * Whitespace in macros: Defining Macros. * Whitespace, inserting: Multiple Spaces. * Width of images: Images. * Width of text area: pagesizes. * Widths, defining multitable column: Multitable Column Widths. * Wildcards: Format with tex/texindex. * Words and phrases, marking them: Marking Text. * Writing a menu: Writing a Menu. * Writing an @node line: Writing a Node. * Writing index entries: Indexing Commands. * XPM image format: Images. * Zaretskii, Eli: History. * Zuhn, David D.: History. ntents. * Showing the section structure of a file: Showing the Structure. * Showing the structure of a file: Using texinfo-sho./info/info-stnd.info 644 0 0 5114 7442531465 7666 This is info-stnd.info, produced by makeinfo version 4.1 from info-stnd.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * info standalone: (info-stnd). Read Info documents without Emacs. * infokey: (info-stnd)Invoking infokey. Compile Info customizations. END-INFO-DIR-ENTRY This file documents GNU Info, a program for viewing the on-line formatted versions of Texinfo files. This documentation is different from the documentation for the Info reader that is part of GNU Emacs. If you do not know how to use Info, but have a working Info reader, you should read that documentation first. Copyright (C) 1992, 93, 96, 97, 98, 99, 2001, 02 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the sections entitled "Copying" and "GNU General Public License" are included exactly as in the original, and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  Indirect: info-stnd.info-1: 1521 info-stnd.info-2: 50490  Tag Table: (Indirect) Node: Top1521 Node: What is Info2956 Node: Invoking Info3499 Ref: --apropos3922 Ref: --show-options9297 Ref: --vi-keys10609 Ref: command-line menu items10902 Ref: Invoking Info-Footnote-112012 Ref: Invoking Info-Footnote-212060 Ref: Invoking Info-Footnote-312445 Node: Cursor Commands12653 Ref: Cursor Commands-Footnote-115437 Ref: Cursor Commands-Footnote-215719 Node: Scrolling Commands15871 Node: Node Commands22241 Ref: goto-node26014 Ref: goto-invocation26589 Node: Searching Commands29914 Node: Xref Commands34814 Node: Parts of an Xref35432 Node: Selecting Xrefs37401 Node: Window Commands39582 Node: The Mode Line40523 Node: Basic Windows42428 Node: The Echo Area44946 Ref: The Echo Area-Footnote-150400 Node: Printing Nodes50490 Node: Miscellaneous Commands51644 Node: Variables55904 Node: Custom Key Bindings62316 Ref: Custom Key Bindings-Footnote-163437 Node: Invoking infokey63639 Ref: Invoking infokey-Footnote-164293 Node: infokey source format64421 Node: Index68843  End Tag Table Writing a Menu. * Writing an @node line: Writing a Node. * Writing index entries: Indexing Commands. * XPM image format: Images. * Zaretskii, Eli: History. * Zuhn, David D.: History. ntents. * Showing the section structure of a file: Showing the Structure. * Showing the structure of a file: Using texinfo-sho./info/info-stnd.info-1 644 0 0 142472 7442531465 10075 This is info-stnd.info, produced by makeinfo version 4.1 from info-stnd.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * info standalone: (info-stnd). Read Info documents without Emacs. * infokey: (info-stnd)Invoking infokey. Compile Info customizations. END-INFO-DIR-ENTRY This file documents GNU Info, a program for viewing the on-line formatted versions of Texinfo files. This documentation is different from the documentation for the Info reader that is part of GNU Emacs. If you do not know how to use Info, but have a working Info reader, you should read that documentation first. Copyright (C) 1992, 93, 96, 97, 98, 99, 2001, 02 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the sections entitled "Copying" and "GNU General Public License" are included exactly as in the original, and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  File: info-stnd.info, Node: Top, Next: What is Info, Up: (dir) GNU Info ******** This file documents GNU Info, a program for viewing the on-line formatted versions of Texinfo files, version 4.1. This documentation is different from the documentation for the Info reader that is part of GNU Emacs. This manual is for Info version 4.1, updated 2 March 2002. * Menu: * What is Info:: What is Info? * Invoking Info:: Options you can pass on the command line. * Cursor Commands:: Commands which move the cursor within a node. * Scrolling Commands:: Commands for reading the text within a node. * Node Commands:: Commands for selecting a new node. * Searching Commands:: Commands for searching an Info file. * Xref Commands:: Commands for selecting cross references. * Window Commands:: Commands which manipulate multiple windows. * Printing Nodes:: How to print out the contents of a node. * Miscellaneous Commands:: A few commands that defy categories. * Variables:: How to change the default behavior of Info. * Custom Key Bindings:: How to define your own key-to-command bindings. * Index:: Global index containing keystrokes, command names, variable names, and general concepts.  File: info-stnd.info, Node: What is Info, Next: Invoking Info, Prev: Top, Up: Top What is Info? ************* "Info" is a program which is used to view Info files on an ASCII terminal. "Info files" are the result of processing Texinfo files with the program `makeinfo' or with one of the Emacs commands, such as `M-x texinfo-format-buffer'. Texinfo itself is a documentation system that uses a single source file to produce both on-line information and printed output. You can typeset and print the files that you read in Info.  File: info-stnd.info, Node: Invoking Info, Next: Cursor Commands, Prev: What is Info, Up: Top Invoking Info ************* GNU Info accepts several options to control the initial node being viewed, and to specify which directories to search for Info files. Here is a template showing an invocation of GNU Info from the shell: info [OPTION]... [MENU-ITEM...] The program accepts the following options: `--apropos=STRING' Specify a string to search in every index of every Info file installed on your system. Info looks up the named STRING in all the indices it can find, prints the results to standard output, and then exits. If you are not sure which Info file explains certain issues, this option is your friend. Note that if your system has a lot of Info files installed, searching all of them might take some time. You can invoke the apropos command from inside Info; see *Note Searching Commands::. `--directory DIRECTORY-PATH' `-d DIRECTORY-PATH' Prepend DIRECTORY-PATH to the list of directory paths searched when Info needs to find a file. You may issue `--directory' multiple times; once for each directory which contains Info files. The list of directories searched by Info is constructed from the value of the environment variable `INFOPATH'; `--directory' causes the named DIRECTORY-PATH to be prepended to that list. The value of `INFOPATH' is a list of directories usually separated by a colon; on MS-DOS/MS-Windows systems, the semicolon is used. If you do not define `INFOPATH', Info uses a default path defined when Info was built as the initial list of directories. If the value of `INFOPATH' ends with a colon (or semicolon on MS-DOS/MS-Windows), the initial list of directories is constructed by appending the build-time default to the value of `INFOPATH'. `--dribble=DRIBBLE-FILE' Specify a file where all user keystrokes will be recorded. This file can be used later to replay the same sequence of commands, see the `--restore' option below. `--file FILENAME' `-f FILENAME' Specify a particular Info file to visit. By default, Info visits the file `dir'; if you use this option, Info will start with `(FILENAME)Top' as the first file and node. If FILENAME is an absolute file name, or begins with `./' or `../', Info looks for FILENAME only in the directory of the specified FILENAME, and adds the directory of FILENAME to the value of `INFOPATH'. In contrast, if FILENAME is in the form of a relative file name, but without the `./' or `../' prefix, Info will only look for it in the directories specified in `INFOPATH'. In other words, Info does _not_ treat file names which lack `./' and `../' prefix as relative to the current directory. In every directory Info tries, if FILENAME is not found, Info looks for it with a number of known extensions of Info files(1). For every known extension, Info looks for a compressed file, if a regular file isn't found. Info supports files compressed with `gzip', `bzip2', `compress' and `yabba' programs; it calls `gunzip', `bunzip2', `uncompress' and `unyabba', accordingly, to decompress such files. Compressed Info files are assumed to have `.z', `.gz', `.bz2', `.Z', or `.Y' extensions, possibly in addition to one of the known Info files extensions(2). `--help' `-h' Produces a relatively brief description of the available Info options. `--index-search STRING' After processing all command-line arguments, go to the index in the Info file and search for index entries which matche STRING. If such an entry is found, the Info session begins with displaying the node pointed to by the first matching index entry; press `,' to step through the rest of the matching entries. If no such entry exists, print `no entries found' and exit with nonzero status. This can be used from another program as a way to provide online help, or as a quick way of starting to read an Info file at a certain node when you don't know the exact name of that node. This command can also be invoked from inside Info; see *Note Searching Commands::. `--node NODENAME' `-n NODENAME' Specify a particular node to visit in the initial file that Info loads. This is especially useful in conjunction with `--file'(3). You may specify `--node' multiple times; for an interactive Info, each NODENAME is visited in its own window, for a non-interactive Info (such as when `--output' is given) each NODENAME is processed sequentially. `--output FILENAME' `-o FILENAME' Specify FILENAME as the name of a file to which to direct output. Each node that Info visits will be output to FILENAME instead of interactively viewed. A value of `-' for FILENAME specifies the standard output. `--raw-escapes' `-R' Do not remove ANSI escape sequences from man pages. Some versions of Groff, the GNU document formatter, produce man pages with ANSI escape sequences for bold, italics, and underlined characters, and for colorized text. By default, Info removes those escape sequences before it displays the man page. If your terminal supports these escapes, use `--raw-escapes' to let the terminal handle them and display the man pages with those attributes. `--restore=DRIBBLE-FILE' Read keystrokes from DRIBBLE-FILE, presumably recorded during previous Info session (see the description of the `--dribble' option above). When the keystrokes in the files are all read, Info reverts its input to the usual interactive operation. `--show-options' `--usage' `-O' This option causes Info to look for the node that describes how to invoke the program and its command-line options, and begin the session by displaying that node. It is provided to make it easier to find the most important usage information in a manual without the need to wade through complex menu hierarchies. The effect is similar to the `M-x goto-invocation' command (*note goto-invocation::) from inside Info. `--speech-friendly' `-b' On MS-DOS/MS-Windows only, this option causes Info to use standard file I/O functions for screen writes. (By default, Info uses direct writes to the video memory on these systems, for faster operation and colored display support.) This allows the speech synthesizers used by blind persons to catch the output and convert it to audible speech. `--subnodes' This option only has meaning when given in conjunction with `--output'. It means to recursively output the nodes appearing in the menus of each node being output. Menu items which resolve to external Info files are not output, and neither are menu items which are members of an index. Each node is only output once. `--version' Prints the version information of Info and exits. `--vi-keys' This option binds functions to keys differently, to emulate the key bindings of `vi' and Less. The default key bindings are generally modeled after Emacs. (*Note Custom Key Bindings::, for a more general way of altering GNU Info's key bindings.) `MENU-ITEM' Info treats its remaining arguments as the names of menu items. The first argument is a menu item in the initial node visited (generally `dir'), the second argument is a menu item in the first argument's node, etc. You can easily move to the node of your choice by specifying the menu names which describe the path to that node. For example, info emacs buffers first selects the menu item `Emacs' in the node `(dir)Top', and then selects the menu item `Buffers' in the node `(emacs)Top'. To avoid searching the `dir' files and just show some arbitrary file, use `-f' and the filename, as in `info -f ./foo.info'. The index search and the search for the node which describes program invocation and command-line options begins _after_ processing all the command-line menu items. Therefore, the Info file searched for the index or the invocation node is the file where Info finds itself after following all the menu items given on the command line. This is so `info emacs --show-options' does what you'd expect. ---------- Footnotes ---------- (1) `.info', `-info', `/index', and `.inf'. (2) The MS-DOS version allows for the Info extension, such as `.inf', and the short compressed file extensions, such as `.z' and `.gz', to be merged into a single extension, since DOS doesn't allow more than a single dot in the basename of a file. Thus, on MS-DOS, if Info looks for `bison', file names like `bison.igz' and `bison.inz' will be found and decompressed by `gunzip'. (3) Of course, you can specify both the file and node in a `--node' command; but don't forget to escape the open and close parentheses and whitespace from the shell as in: `info --node "(emacs)Buffers"'.  File: info-stnd.info, Node: Cursor Commands, Next: Scrolling Commands, Prev: Invoking Info, Up: Top Moving the Cursor ***************** Many people find that reading screens of text page by page is made easier when one is able to indicate particular pieces of text with some kind of pointing device. Since this is the case, GNU Info (both the Emacs and standalone versions) have several commands which allow you to move the cursor about the screen. The notation used in this manual to describe keystrokes is identical to the notation used within the Emacs manual, and the GNU Readline manual. *Note Character Conventions: (emacs)Characters, if you are unfamiliar with the notation(1). The following table lists the basic cursor movement commands in Info. Each entry consists of the key sequence you should type to execute the cursor movement, the `M-x'(2) command name (displayed in parentheses), and a short description of what the command does. All of the cursor motion commands can take a "numeric" argument (see *Note `universal-argument': Miscellaneous Commands. With a numeric argument, the motion commands are simply executed that many times; for example, a numeric argument of 4 given to `next-line' causes the cursor to move down 4 lines. With a negative numeric argument, the motion is reversed; an argument of -4 given to the `next-line' command would cause the cursor to move _up_ 4 lines. (`next-line') (an arrow key) Move the cursor down to the next line. (`prev-line') (an arrow key) Move the cursor up to the previous line. (`beginning-of-line') (on DOS/Windows only) Move the cursor to the start of the current line. (`end-of-line') (on DOS/Windows only) Move the cursor to the end of the current line. (`forward-char') (an arrow key) Move the cursor forward a character. (`backward-char') (an arrow key) Move the cursor backward a character. (`forward-word') `C-' (on DOS/Windows only) Move the cursor forward a word. (`backward-word') `C-' (on DOS/Windows only) Move the cursor backward a word. (`beginning-of-node') > (on DOS/Windows only) , vi-like operation Move the cursor to the start of the current node. > (`end-of-node') > (on DOS/Windows only) Move the cursor to the end of the current node. (`move-to-window-line') Move the cursor to a specific line of the window. Without a numeric argument, `M-r' moves the cursor to the start of the line in the center of the window. With a numeric argument of N, `M-r' moves the cursor to the start of the Nth line in the window. ---------- Footnotes ---------- (1) Here's a short summary. `C-X' means press the `CTRL' key and the key X. `M-X' means press the `META' key and the key X. On many terminals th `META' key is known as the `ALT' key. `SPC' is the space bar. The other keys are usually called by the names imprinted on them. (2) `M-x' is also a command; it invokes `execute-extended-command'. *Note Executing an extended command: (emacs)M-x, for more detailed information.  File: info-stnd.info, Node: Scrolling Commands, Next: Node Commands, Prev: Cursor Commands, Up: Top Moving Text Within a Window *************************** Sometimes you are looking at a screenful of text, and only part of the current paragraph you are reading is visible on the screen. The commands detailed in this section are used to shift which part of the current node is visible on the screen. Scrolling commands are bound differently when `--vi-keys' operation (*note --vi-keys::) is in effect. These key bindings are designated with "vi-like operation". (`scroll-forward') Shift the text in this window up. That is, show more of the node which is currently below the bottom of the window. With a numeric argument, show that many more lines at the bottom of the window; a numeric argument of 4 would shift all of the text in the window up 4 lines (discarding the top 4 lines), and show you four new lines at the bottom of the window. Without a numeric argument, takes the bottom two lines of the window and places them at the top of the window, redisplaying almost a completely new screenful of lines. If you are at the end of a node, takes you to the "next" node, so that you can read an entire manual from start to finish by repeating . The default scroll size is one screen-full, but it can be changed by invoking the (`scroll-forward-page-only-set-window') command, `z' under `--vi-keys', with a numeric argument. (an arrow key) (`scroll-forward-page-only') , vi-like operation , vi-like operation , vi-like operation Shift the text in this window up. This is identical to the operation above, except that it never scrolls beyond the end of the current node. The key is known as the key on some keyboards. (`scroll-forward-page-only-set-window', vi-like operation) Scroll forward, like with , but if a numeric argument is specified, it becomes the default scroll size for subsequent `scroll-forward' and `scroll-backward' commands and their ilk. (`scroll-backward') Shift the text in this window down. The inverse of `scroll-forward'. If you are at the start of a node, takes you to the "previous" node, so that you can read an entire manual from finish to start by repeating . The default scroll size can be changed by invoking the (`scroll-backward-page-only-set-window') command, `w' under `--vi-keys', with a numeric argument. (arrow key) (`scroll-backward-page-only') (arrow key) , vi-like operation , vi-like operation Shift the text in this window down. The inverse of `scroll-forward-page-only'. Does not scroll beyond the start of the current node. The default scroll size can be changed by invoking the(`scroll-backward-page-only-set-window') command, `w' under `--vi-keys', with a numeric argument. (`scroll-backward-page-only-set-window', vi-like operation) Scroll backward, like with , but if a numeric argument is specified, it becomes the default scroll size for subsequent `scroll-forward' and `scroll-backward' commands. (`down-line', vi-like operation) , vi-like operation , vi-like operation , vi-like operation , vi-like operation Scroll forward by one line. With a numeric argument, scroll forward that many lines. (`up-line', vi-like operation) , vi-like operation , vi-like operation , vi-like operation , vi-like operation , vi-like operation Scroll backward one line. With a numeric argument, scroll backward that many lines. (`scroll-half-screen-down', vi-like operation) , vi-like operation Scroll forward by half of the screen size. With a numeric argument, scroll that many lines. If an argument is specified, it becomes the new default number of lines to scroll for subsequent `d' and `u' commands. (`scroll-half-screen-up', vi-like operation) , vi-like operation Scroll back by half of the screen size. With a numeric argument, scroll that many lines. If an argument is specified, it becomes the new default number of lines to scroll for subsequent `u' and `d' commands. The `scroll-forward' and `scroll-backward' commands can also move forward and backward through the node structure of the file. If you press while viewing the end of a node, or while viewing the beginning of a node, what happens is controlled by the variable `scroll-behavior'. *Note `scroll-behavior': Variables, for more information. The `scroll-forward-page-only' and `scroll-backward-page-only' commands never scroll beyond the current node. The key is the key on many keyboards. Emacs refers to it by the name . When you use or to scroll, Info never scrolls beyond the beginning of the current node. If your keyboard lacks the key, look for a key called , or `BackSpace', sometimes designated with an arrow which points to the left, which should perform the same function. (`redraw-display') Redraw the display from scratch, or shift the line containing the cursor to a specified location. With no numeric argument, `C-l' clears the screen, and then redraws its entire contents. Given a numeric argument of N, the line containing the cursor is shifted so that it is on the Nth line of the window. `C-x ' (`toggle-wrap') Toggles the state of line wrapping in the current window. Normally, lines which are longer than the screen width "wrap", i.e., they are continued on the next line. Lines which wrap have a `\' appearing in the rightmost column of the screen. You can cause such lines to be terminated at the rightmost column by changing the state of line wrapping in the window with `C-x w'. When a line which needs more space than one screen width to display is displayed, a `$' appears in the rightmost column of the screen, and the remainder of the line is invisible. When long lines are truncated, the modeline displays the `$' character near its left edge.  File: info-stnd.info, Node: Node Commands, Next: Searching Commands, Prev: Scrolling Commands, Up: Top Selecting a Node **************** This section details the numerous Info commands which select a new node to view in the current window. The most basic node commands are `n', `p', `u', and `l'. Note that the commands to select nodes are mapped differently when `--vi-keys' is in effect; these keybindings are designated below as "vi-like operation". When you are viewing a node, the top line of the node contains some Info "pointers" which describe where the next, previous, and up nodes are. Info uses this line to move about the node structure of the file when you use the following commands: (`next-node') `C-' (on DOS/Windows only) `C-x ', vi-like operation Select the `Next' node. The key is known as the key on some keyboards.

      (`prev-node') `C-' (on DOS/Windows only) Select the `Prev' node. The key is known as the key on some keyboards. (`up-node') `C-' (an arrow key on DOS/Windows only) `C-x ', vi-like operation Select the `Up' node. You can easily select a node that you have already viewed in this window by using the `l' command - this name stands for "last", and actually moves backwards through the history of visited nodes for this window. This is handy when you followed a reference to another node, possibly to read about a related issue, and would like then to resume reading at the same place where you started the excursion. Each node where you press `l' is discarded from the history. Thus, by the time you get to the first node you visited in a window, the entire history of that window is discarded. (`history-node') > (on DOS/Windows only) <'>, vi-like operation Pop the most recently selected node in this window from the node history. Two additional commands make it easy to select the most commonly selected nodes; they are `t' and `d'. (`top-node') , vi-like operation Select the node `Top' in the current Info file. (`dir-node') , vi-like operation Select the directory node (i.e., the node `(dir)'). Here are some other commands which immediately result in the selection of a different node in the current window: <<> (`first-node') , vi-like operation Selects the first node which appears in this file. This node is most often `Top', but it does not have to be. With a numeric argument N, select the Nth node (the first node is node 1). An argument of zero is the same as the argument of 1. <>> (`last-node') , vi-like operation Select the last node which appears in this file. With a numeric argument N, select the Nth node (the first node is node 1). An argument of zero is the same as no argument, i.e., it selects the last node. <]> (`global-next-node') Move forward or down through node structure. If the node that you are currently viewing has a `Next' pointer, that node is selected. Otherwise, if this node has a menu, the first menu item is selected. If there is no `Next' and no menu, the same process is tried with the `Up' node of this node. <[> (`global-prev-node') Move backward or up through node structure. If the node that you are currently viewing has a `Prev' pointer, that node is selected. Otherwise, if the node has an `Up' pointer, that node is selected, and if it has a menu, the last item in the menu is selected. You can get the same behavior as `global-next-node' and `global-prev-node' while simply scrolling through the file with and ; *Note `scroll-behavior': Variables, for more information. (`goto-node') `C-x ', vi-like operation Read the name of a node and select it. While reading the node name, completion (*note completion: The Echo Area.) is only done for the nodes which reside in one of the Info files that were loaded in the current Info session; if the desired node resides in some other file, you must type the node exactly as it appears in that Info file, and you must include the Info file of the other file. For example, `g(emacs)Buffers' finds the node `Buffers' in the Info file `emacs'. (`goto-invocation' Read the name of a program and look for a node in the current Info file which describes the invocation and the command-line options for that program. The default program name is derived from the name of the current Info file. This command does the same as the `--show-options' command-line option (*note --show-options::), but it also allows to specify the program name; this is important for those manuals which describe several programs. If you need to find the Invocation node of a program that is documented in another Info file, you need to visit that file before invoking `I'. For example, if you are reading the Emacs manual and want to see the command-line options of the `makeinfo' program, type `g (texinfo) ' and then `I makeinfo '. If you don't know what Info file documents the command, or if invoking `I' doesn't display the right node, go to the `(dir)' node (using the `d' command) and invoke `I' from there. (`menu-sequence') Read a sequence of menu entries and follow it. Info prompts for a sequence of menu items separated by commas. (Since commas are not allowed in a node name, they are a natural choice for a delimiter in a list of menu items.) Info then looks up the first item in the menu of the node `(dir)' (if the `(dir)' node cannot be found, Info uses `Top'). If such an entry is found, Info goes to the node it points to and looks up the second item in the menu of that node, etc. In other words, you can specify a complete path which descends through the menu hierarchy of a particular Info file starting at the `(dir)' node. This has the same effect as if you typed the menu item sequence on Info's command line, see *Note Info command-line arguments processing: command-line menu items. For example, G Texinfo,Overview,Reporting Bugs displays the node `Reporting Bugs' in the Texinfo manual. (You don't actually need to type the menu items in their full length, or in their exact letter-case. However, if you do type the menu items exactly, Info will find it faster.) If any of the menu items you type are not found, Info stops at the last entry it did find and reports an error. `C-x ' (`kill-node') Kill a node. The node name is prompted for in the echo area, with a default of the current node. "Killing" a node means that Info tries hard to forget about it, removing it from the list of history nodes kept for the window where that node is found. Another node is selected in the window which contained the killed node. `C-x C-f' (`view-file') Read the name of a file and selects the entire file. The command `C-x C-f FILENAME' is equivalent to typing `g(FILENAME)*' `C-x C-b' (`list-visited-nodes') Make a window containing a menu of all of the currently visited nodes. This window becomes the selected window, and you may use the standard Info commands within it. `C-x ' (`select-visited-node') Select a node which has been previously visited in a visible window. This is similar to `C-x C-b' followed by `m', but no window is created.  File: info-stnd.info, Node: Searching Commands, Next: Xref Commands, Prev: Node Commands, Up: Top Searching an Info File ********************** GNU Info allows you to search for a sequence of characters throughout an entire Info file, search through the indices of an Info file, or find areas within an Info file which discuss a particular topic. (`search') Read a string in the echo area and search for it. If the string includes upper-case characters, the Info file is searched case-sensitively; otherwise Info ignores the letter case. With a numeric argument of N, search for Nth occurrence of the string. Negative arguments search backwards. (`search-backward', vi-like operation) Read a string in the echo area and search backward through the Info file for that string. If the string includes upper-case characters, the Info file is searched case-sensitively; otherwise Info ignores the letter case. With a numeric argument of N, search for Nth occurrence of the string. Negative arguments search forward. (`search-case-sensitively' Read a string in the echo area and search for it case-sensitively, even if the string includes only lower-case letters. With a numeric argument of N, search for Nth occurrence of the string. Negative arguments search backwards. `C-x ' (`search-next') , vi-like operation Search for the same string used in the last search command, in the same direction, and with the same case-sensitivity option. With a numeric argument of N, search for Nth next occurrence. `C-x ' (`search-previous') , vi-like operation Search for the same string used in the last search command, and with the same case-sensitivity option, but in the reverse direction. With a numeric argument of N, search for Nth previous occurrence. (`isearch-forward') Interactively search forward through the Info file for a string as you type it. If the string includes upper-case characters, the search is case-sensitive; otherwise Info ignores the letter case. (`isearch-backward') Interactively search backward through the Info file for a string as you type it. If the string includes upper-case characters, the search is case-sensitive; otherwise Info ignores the letter case. (`index-search') Look up a string in the indices for this Info file, and select a node where the found index entry points to. <,> (`next-index-match') Move to the node containing the next matching index item from the last `i' command. `M-x index-apropos' Grovel the indices of all the known Info files on your system for a string, and build a menu of the possible matches. The most basic searching command is `s' or `/' (`search'). The `s' command prompts you for a string in the echo area, and then searches the remainder of the Info file for an occurrence of that string. If the string is found, the node containing it is selected, and the cursor is left positioned at the start of the found string. Subsequent `s' commands show you the default search string within `[' and `]'; pressing instead of typing a new string will use the default search string. Under `--vi-keys' (*note --vi-keys::), using the `n' or `N' commands is a faster way of searching for the same string. "Incremental searching" is similar to basic searching, but the string is looked up while you are typing it, instead of waiting until the entire search string has been specified. Both incremental and non-incremental search by default ignore the case of letters when comparing the Info file text with the search string. However, an uppercase letter in the search string makes the search case-sensitive. You can force a case-sensitive non-incremental search, even for a string that includes only lower-case letters, by using the `S' command (`search-case-sensitively'). The `n' and `N' commands operate case-sensitively if the last search command was `S'. The most efficient means of finding something quickly in a manual is the `i' command (`index-search'). This command prompts for a string, and then looks for that string in all the indices of the current Info manual. If it finds a matching index entry, it displays the node to which that entry refers and prints the full text of the entry in the echo area. You can press `,' (`next-index-match') to find more matches. A good Info manual has all of its important concepts indexed, so the `i' command lets you use a manual as a reference. If you don't know what manual documents something, try the `M-x index-apropos'. It prompts for a string and then looks up that string in all the indices of all the Info documents installed on your system. It can also be invoked from the command line; see *Note --apropos::.  File: info-stnd.info, Node: Xref Commands, Next: Window Commands, Prev: Searching Commands, Up: Top Selecting Cross References ************************** We have already discussed the `Next', `Prev', and `Up' pointers which appear at the top of a node. In addition to these pointers, a node may contain other pointers which refer you to a different node, perhaps in another Info file. Such pointers are called "cross references", or "xrefs" for short. * Menu: * Parts of an Xref:: What a cross reference is made of. * Selecting Xrefs:: Commands for selecting menu or note items.  File: info-stnd.info, Node: Parts of an Xref, Next: Selecting Xrefs, Up: Xref Commands Parts of an Xref ================ Cross references have two major parts: the first part is called the "label"; it is the name that you can use to refer to the cross reference, and the second is the "target"; it is the full name of the node that the cross reference points to. The target is separated from the label by a colon `:'; first the label appears, and then the target. For example, in the sample menu cross reference below, the single colon separates the label from the target. * Foo Label: Foo Target. More information about Foo. Note the `.' which ends the name of the target. The `.' is not part of the target; it serves only to let Info know where the target name ends. A shorthand way of specifying references allows two adjacent colons to stand for a target name which is the same as the label name: * Foo Commands:: Commands pertaining to Foo. In the above example, the name of the target is the same as the name of the label, in this case `Foo Commands'. You will normally see two types of cross reference while viewing nodes: "menu" references, and "note" references. Menu references appear within a node's menu; they begin with a `*' at the beginning of a line, and continue with a label, a target, and a comment which describes what the contents of the node pointed to contains. Note references appear within the body of the node text; they begin with `*Note', and continue with a label and a target. Like `Next', `Prev', and `Up' pointers, cross references can point to any valid node. They are used to refer you to a place where more detailed information can be found on a particular subject. Here is a cross reference which points to a node within the Texinfo documentation: *Note Writing an Xref: (texinfo)xref, for more information on creating your own texinfo cross references.  File: info-stnd.info, Node: Selecting Xrefs, Prev: Parts of an Xref, Up: Xref Commands Selecting Xrefs =============== The following table lists the Info commands which operate on menu items. <1> (`menu-digit') <2> ... <9> , vi-like operation ... , vi-like operation Within an Info window, pressing a single digit, (such as `1'), selects that menu item, and places its node in the current window. For convenience, there is one exception; pressing `0' selects the _last_ item in the node's menu. When `--vi-keys' is in effect, digits set the numeric argument, so these commands are remapped to their `M-' varieties. For example, to select the last menu item, press . <0> (`last-menu-item') , vi-like operation Select the last item in the current node's menu. (`menu-item') Reads the name of a menu item in the echo area and selects its node. Completion is available while reading the menu label. *Note completion: The Echo Area. `M-x find-menu' Move the cursor to the start of this node's menu. This table lists the Info commands which operate on cross references. (`xref-item') , vi-like operation `C-x ', vi-like operation Reads the name of a note cross reference in the echo area and selects its node. Completion is available while reading the cross reference label. *Note completion: The Echo Area. Finally, the next few commands operate on menu or note references alike: (`move-to-next-xref') Move the cursor to the start of the next nearest menu item or note reference in this node. You can then use (`select-reference-this-line') to select the menu or note reference. (`move-to-prev-xref') > (on DOS/Windows only) Move the cursor the start of the nearest previous menu item or note reference in this node. On DOS/Windows only, the `Shift-' key is an alias for `M-'. This key is sometimes called `BackTab'. (`select-reference-this-line') , vi-like operation Select the menu item or note reference appearing on this line.  File: info-stnd.info, Node: Window Commands, Next: Printing Nodes, Prev: Xref Commands, Up: Top Manipulating Multiple Windows ***************************** A "window" is a place to show the text of a node. Windows have a view area where the text of the node is displayed, and an associated "mode line", which briefly describes the node being viewed. GNU Info supports multiple windows appearing in a single screen; each window is separated from the next by its modeline. At any time, there is only one "active" window, that is, the window in which the cursor appears. There are commands available for creating windows, changing the size of windows, selecting which window is active, and for deleting windows. * Menu: * The Mode Line:: What appears in the mode line? * Basic Windows:: Manipulating windows in Info. * The Echo Area:: Used for displaying errors and reading input.  File: info-stnd.info, Node: The Mode Line, Next: Basic Windows, Up: Window Commands The Mode Line ============= A "mode line" is a line of inverse video which appears at the bottom of an Info window. It describes the contents of the window just above it; this information includes the name of the file and node appearing in that window, the number of screen lines it takes to display the node, and the percentage of text that is above the top of the window. It can also tell you if the indirect tags table for this Info file needs to be updated, and whether or not the Info file was compressed when stored on disk. Here is a sample mode line for a window containing an uncompressed file named `dir', showing the node `Top'. -----Info: (dir)Top, 40 lines --Top------------------------------------- ^^ ^ ^^^ ^^ (file)Node #lines where When a node comes from a file which is compressed on disk, this is indicated in the mode line with two small `z''s. In addition, if the Info file containing the node has been split into subfiles, the name of the subfile containing the node appears in the modeline as well: --zz-Info: (emacs)Top, 291 lines --Top-- Subfile: emacs-1.Z------------- Truncation of long lines (as opposed to wrapping them to the next display line, *note toggle-wrap: Scrolling Commands.) is indicated by a `$' at the left edge of the mode line: --$--Info: (texinfo)Top, 480 lines --Top-- Subfile: texinfo-1----------- When Info makes a node internally, such that there is no corresponding info file on disk, the name of the node is surrounded by asterisks (`*'). The name itself tells you what the contents of the window are; the sample mode line below shows an internally constructed node showing possible completions: -----Info: *Completions*, 7 lines --All---------------------------------  File: info-stnd.info, Node: Basic Windows, Next: The Echo Area, Prev: The Mode Line, Up: Window Commands Window Commands =============== It can be convenient to view more than one node at a time. To allow this, Info can display more than one "window". Each window has its own mode line (*note The Mode Line::) and history of nodes viewed in that window (*note `history-node': Node Commands.). `C-x ' (`next-window') Select the next window on the screen. Note that the echo area can only be selected if it is already in use, and you have left it temporarily. Normally, `C-x o' simply moves the cursor into the next window on the screen, or if you are already within the last window, into the first window on the screen. Given a numeric argument, `C-x o' moves over that many windows. A negative argument causes `C-x o' to select the previous window on the screen. `M-x prev-window' Select the previous window on the screen. This is identical to `C-x o' with a negative argument. `C-x <2>' (`split-window') Split the current window into two windows, both showing the same node. Each window is one half the size of the original window, and the cursor remains in the original window. The variable `automatic-tiling' can cause all of the windows on the screen to be resized for you automatically, please *note automatic-tiling: Variables. for more information. `C-x <0>' (`delete-window') Delete the current window from the screen. If you have made too many windows and your screen appears cluttered, this is the way to get rid of some of them. `C-x <1>' (`keep-one-window') Delete all of the windows excepting the current one. `ESC ' (`scroll-other-window') Scroll the other window, in the same fashion that `C-v' might scroll the current window. Given a negative argument, scroll the "other" window backward. `C-x <^>' (`grow-window') Grow (or shrink) the current window. Given a numeric argument, grow the current window that many lines; with a negative numeric argument, shrink the window instead. `C-x ' (`tile-windows') Divide the available screen space among all of the visible windows. Each window is given an equal portion of the screen in which to display its contents. The variable `automatic-tiling' can cause `tile-windows' to be called when a window is created or deleted. *Note `automatic-tiling': Variables.  File: info-stnd.info, Node: The Echo Area, Prev: Basic Windows, Up: Window Commands The Echo Area ============= The "echo area" is a one line window which appears at the bottom of the screen. It is used to display informative or error messages, and to read lines of input from you when that is necessary. Almost all of the commands available in the echo area are identical to their Emacs counterparts, so please refer to that documentation for greater depth of discussion on the concepts of editing a line of text. The following table briefly lists the commands that are available while input is being read in the echo area: (`echo-area-forward') (an arrow key) , vi-like operation Move forward a character. (`echo-area-backward') (an arrow key) , vi-like operation Move backward a character. (`echo-area-beg-of-line') , vi-like operation Move to the start of the input line. (`echo-area-end-of-line') , vi-like operation Move to the end of the input line. (`echo-area-forward-word') > (DOS/Windows only) , vi-like operation Move forward a word. On DOS/Windows, `C-' moves forward by words. (`echo-area-backward-word') > (DOS/Windows only) Move backward a word. On DOS/Windows, `C-' moves backward by words. (`echo-area-delete') , vi-like operation Delete the character under the cursor. (`echo-area-rubout') Delete the character behind the cursor. On some keyboards, this key is designated , for `BackSpace'. Those keyboards will usually bind in the echo area to `echo-area-delete'. (`echo-area-abort') , vi-like operation Cancel or quit the current operation. If completion is being read, this command discards the text of the input line which does not match any completion. If the input line is empty, it aborts the calling function. (`echo-area-newline') Accept (or forces completion of) the current input line. (`echo-area-quoted-insert') , vi-like operation Insert the next character verbatim. This is how you can insert control characters into a search string, for example, or the `?' character when Info prompts with completion. PRINTING CHARACTER (`echo-area-insert') Insert the character. Characters that have their 8th bit set, and not bound to `M-' commands, are also inserted verbatim; this is useful for terminals which support Latin scripts. (`echo-area-tab-insert') > (on DOS/Windows only) Insert a TAB character. On DOS/Windows only, the `Shift-' key is an alias for `M-'. This key is sometimes called `BackTab'. (`echo-area-transpose-chars') Transpose the characters at the cursor. The next group of commands deal with "killing", and "yanking" text(1). For an in depth discussion of killing and yanking, *note Killing and Deleting: (emacs)Killing. (`echo-area-kill-word') , vi-like operation Kill the word following the cursor. (`echo-area-backward-kill-word') > Kill the word preceding the cursor. On some keyboards, the `Backspace' key is used instead of `DEL', so `M-' has the same effect as `M-'. (`echo-area-kill-line') Kill the text from the cursor to the end of the line. `C-x ' (`echo-area-backward-kill-line') Kill the text from the cursor to the beginning of the line. (`echo-area-yank') Yank back the contents of the last kill. (`echo-area-yank-pop') Yank back a previous kill, removing the last yanked text first. Sometimes when reading input in the echo area, the command that needed input will only accept one of a list of several choices. The choices represent the "possible completions", and you must respond with one of them. Since there are a limited number of responses you can make, Info allows you to abbreviate what you type, only typing as much of the response as is necessary to uniquely identify it. In addition, you can request Info to fill in as much of the response as is possible; this is called "completion". The following commands are available when completing in the echo area: (`echo-area-complete') Insert as much of a completion as is possible. (`echo-area-possible-completions') Display a window containing a list of the possible completions of what you have typed so far. For example, if the available choices are: bar foliate food forget and you have typed an `f', followed by `?', Info will pop up a window showing a node called `*Completions*' which lists the possible completions like this: 3 completions: foliate food forget i.e., all of the choices which begin with `f'. Pressing or would result in `fo' appearing in the echo area, since all of the choices which begin with `f' continue with `o'. Now, typing `l' followed by `TAB' results in `foliate' appearing in the echo area, since that is the only choice which begins with `fol'. (`echo-area-scroll-completions-window') Scroll the completions window, if that is visible, or the "other" window if not. ---------- Footnotes ---------- (1) Some people are used to calling these operations "cut" and "paste", respectively. ly constructed node showing possible completions: -----Info: *Completions*, 7 lines --All---------------------------------  File: info-stnd.info, Node: Basic Windows, Next: The Echo Area, ./info/info-stnd.info-2 644 0 0 122405 7442531465 10070 This is info-stnd.info, produced by makeinfo version 4.1 from info-stnd.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * info standalone: (info-stnd). Read Info documents without Emacs. * infokey: (info-stnd)Invoking infokey. Compile Info customizations. END-INFO-DIR-ENTRY This file documents GNU Info, a program for viewing the on-line formatted versions of Texinfo files. This documentation is different from the documentation for the Info reader that is part of GNU Emacs. If you do not know how to use Info, but have a working Info reader, you should read that documentation first. Copyright (C) 1992, 93, 96, 97, 98, 99, 2001, 02 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the sections entitled "Copying" and "GNU General Public License" are included exactly as in the original, and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  File: info-stnd.info, Node: Printing Nodes, Next: Miscellaneous Commands, Prev: Window Commands, Up: Top Printing Nodes ************** In general, we recommend that you use TeX to format the document and print sections of it, by running `tex' on the Texinfo source file. However, you may wish to print out the contents of a node as a quick reference document for later use, or if you don't have TeX installed. Info provides you with a command for doing this. `M-x print-node' Pipe the contents of the current node through the command in the environment variable `INFO_PRINT_COMMAND'. If the variable does not exist, the node is simply piped to `lpr' (on DOS/Windows, the default is to print the node to the local printer device, `PRN'). The value of `INFO_PRINT_COMMAND' may begin with the `>' character, as in `>/dev/printer', in which case Info treats the rest as the name of a file or a device. Instead of piping to a command, Info opens the file, writes the node contents, and closes the file, under the assumption that text written to that file will be printed by the underlying OS.  File: info-stnd.info, Node: Miscellaneous Commands, Next: Variables, Prev: Printing Nodes, Up: Top Miscellaneous Commands ********************** GNU Info contains several commands which self-document GNU Info: `M-x describe-command' Read the name of an Info command in the echo area and then display a brief description of what that command does. `M-x describe-key' Read a key sequence in the echo area, and then display the name and documentation of the Info command that the key sequence invokes. `M-x describe-variable' Read the name of a variable in the echo area and then display a brief description of what the variable affects. `M-x where-is' Read the name of an Info command in the echo area, and then display a key sequence which can be typed in order to invoke that command. (`get-help-window') (on DOS/Windows only) h, vi-like operation Create (or Move into) the window displaying `*Help*', and place a node containing a quick reference card into it. This window displays the most concise information about GNU Info available. (`get-info-help-node') , vi-like operation Try hard to visit the node `(info)Help'. The Info file `info.texi' distributed with GNU Info contains this node. Of course, the file must first be processed with `makeinfo', and then placed into the location of your Info directory. Here are the commands for creating a numeric argument: (`universal-argument') Start (or multiply by 4) the current numeric argument. `C-u' is a good way to give a small numeric argument to cursor movement or scrolling commands; `C-u C-v' scrolls the screen 4 lines, while `C-u C-u C-n' moves the cursor down 16 lines. `C-u' followed by digit keys sets the numeric argument to the number thus typed: `C-u 1 2 0' sets the argument to 120. (`add-digit-to-numeric-arg') <1>, vi-like operation ... <2> ... <9>, vi-like operation <0>, vi-like operation Add the digit value of the invoking key to the current numeric argument. Once Info is reading a numeric argument, you may just type the digits of the argument, without the Meta prefix. For example, you might give `C-l' a numeric argument of 32 by typing: C-u 3 2 C-l or M-3 2 C-l (`add-digit-to-numeric-arg' <-> To make a negative argument, type `-'. Typing `-' alone makes a negative argument with a value of -1. If you continue to type digit or Meta-digit keys after `-', the result is a negative number produced by those digits. `-' doesn't work when you type in the echo area, because you need to be able to insert the `-' character itself; use `M--' instead, if you need to specify negative arguments in the echo area. `C-g' is used to abort the reading of a multi-character key sequence, to cancel lengthy operations (such as multi-file searches) and to cancel reading input in the echo area. (`abort-key') , vi-like operation Cancel current operation. The `q' command of Info simply quits running Info. Under `--vi-keys' (*note --vi-keys::), you can also exit with `:q' or `ZZ'. (`quit') `C-x C-c' `:q', vi-like operation `ZZ', vi-like operation Exit GNU Info. If the operating system tells GNU Info that the screen is 60 lines tall, and it is actually only 40 lines tall, here is a way to tell Info that the operating system is correct. `M-x set-screen-height' Read a height value in the echo area and set the height of the displayed screen to that value. On MS-DOS/MS-Windows, this command actually tries to change the dimensions of the visible screen to the value you type in the echo area. Finally, Info provides a convenient way to display footnotes which might be associated with the current node that you are viewing: (`show-footnotes') Show the footnotes (if any) associated with the current node in another window. You can have Info automatically display the footnotes associated with a node when the node is selected by setting the variable `automatic-footnotes'. *Note `automatic-footnotes': Variables.  File: info-stnd.info, Node: Variables, Next: Custom Key Bindings, Prev: Miscellaneous Commands, Up: Top Manipulating Variables ********************** GNU Info contains several "variables" whose values are looked at by various Info commands. You can change the values of these variables, and thus change the behavior of Info to more closely match your environment and Info file reading manner. There are two ways to set the value of a variable: interactively, using the `set-variable' command described below, or in the `#var' section of the `.infokey' file. *Note Custom Key Bindings::. `M-x set-variable' Read the name of a variable, and the value for it, in the echo area and then set the variable to that value. Completion is available when reading the variable name (*note completion: The Echo Area.); often, completion is available when reading the value to give to the variable, but that depends on the variable itself. If a variable does _not_ supply multiple choices to complete over, it expects a numeric value. `M-x describe-variable' Read the name of a variable in the echo area and then display a brief description of what the variable affects. Here is a list of the variables that you can set in Info. `automatic-footnotes' When set to `On', footnotes appear and disappear automatically. This variable is `On' by default. When a node is selected, a window containing the footnotes which appear in that node is created, and the footnotes are displayed within the new window. The window that Info creates to contain the footnotes is called `*Footnotes*'. If a node is selected which contains no footnotes, and a `*Footnotes*' window is on the screen, the `*Footnotes*' window is deleted. Footnote windows created in this fashion are not automatically tiled so that they can use as little of the display as is possible. `automatic-tiling' When set to `On', creating or deleting a window resizes other windows. This variable is `Off' by default. Normally, typing `C-x 2' divides the current window into two equal parts. When `automatic-tiling' is set to `On', all of the windows are resized automatically, keeping an equal number of lines visible in each window. There are exceptions to the automatic tiling; specifically, the windows `*Completions*' and `*Footnotes*' are _not_ resized through automatic tiling; they remain their original size. `errors-ring-bell' When set to `On', errors cause the bell to ring. The default setting of this variable is `On'. `gc-compressed-files' When set to `On', Info garbage collects files which had to be uncompressed. The default value of this variable is `Off'. Whenever a node is visited in Info, the Info file containing that node is read into core, and Info reads information about the tags and nodes contained in that file. Once the tags information is read by Info, it is never forgotten. However, the actual text of the nodes does not need to remain in core unless a particular Info window needs it. For non-compressed files, the text of the nodes does not remain in core when it is no longer in use. But de-compressing a file can be a time consuming operation, and so Info tries hard not to do it twice. `gc-compressed-files' tells Info it is okay to garbage collect the text of the nodes of a file which was compressed on disk. `ISO-Latin' When set to `On', Info accepts and displays ISO Latin characters. By default, Info assumes an ASCII character set. `ISO-Latin' tells Info that it is running in an environment where the European standard character set is in use, and allows you to input such characters to Info, as well as display them. `scroll-behavior' Control what happens when forward scrolling is requested at the end of a node, or when backward scrolling is requested at the beginning of a node. The default value for this variable is `Continuous'. There are three possible values for this variable: `Continuous' Try to get the first item in this node's menu, or failing that, the `Next' node, or failing that, the `Next' of the `Up'. This behavior is identical to using the `]' (`global-next-node') and `[' (`global-prev-node') commands. `Next Only' Only try to get the `Next' node. `Page Only' Simply give up, changing nothing. If `scroll-behavior' is `Page Only', no scrolling command can change the node that is being viewed. `scroll-step' The number of lines to scroll when the cursor moves out of the window. Scrolling happens automatically if the cursor has moved out of the visible portion of the node text when it is time to display. Usually the scrolling is done so as to put the cursor on the center line of the current window. However, if the variable `scroll-step' has a nonzero value, Info attempts to scroll the node text by that many lines; if that is enough to bring the cursor back into the window, that is what is done. The default value of this variable is 0, thus placing the cursor (and the text it is attached to) in the center of the window. Setting this variable to 1 causes a kind of "smooth scrolling" which some people prefer. `show-index-match' When set to `On', the portion of the matched search string is highlighted in the message which explains where the matched search string was found. The default value of this variable is `On'. When Info displays the location where an index match was found, (*note `next-index-match': Searching Commands.), the portion of the string that you had typed is highlighted by displaying it in the inverse case from its surrounding characters. `visible-bell' When set to `On', GNU Info attempts to flash the screen instead of ringing the bell. This variable is `Off' by default. Of course, Info can only flash the screen if the terminal allows it; in the case that the terminal does not allow it, the setting of this variable has no effect. However, you can make Info perform quietly by setting the `errors-ring-bell' variable to `Off'.  File: info-stnd.info, Node: Custom Key Bindings, Next: Index, Prev: Variables, Up: Top Customizing Key Bindings and Variables ************************************** For those whose editor/pager of choice is not Emacs and who are not entirely satisfied with the -vi-keys option (*note --vi-keys::), GNU Info provides a way to define different key-to-command bindings and variable settings from the defaults described in this document. On startup, GNU Info looks for a configuration file in the invoker's HOME directory called `.info'(1). If it is present, and appears to contain Info configuration data, and was created with the current version of the `infokey' command, then Info adopts the key bindings and variable settings contained therein. The `.info' file contains compact, non-textual data for reasons of efficiency and because its design was lifted wholesale from the GNU Less program, which also does it that way. It must be created by compiling a textual source file using the `infokey' command. * Menu: * Invoking infokey:: * infokey source format:: ---------- Footnotes ---------- (1) Due to the limitations of DOS filesystems, the MS-DOS version of Info looks for a file `_info' instead. If the `HOME' variable is not defined, Info additionally looks in the current directory.  File: info-stnd.info, Node: Invoking infokey, Next: infokey source format, Up: Custom Key Bindings Invoking `infokey' ================== `infokey' compiles a source file (`$HOME/.infokey'(1) by default) containing Info customizations into a binary format (`$HOME/.info' by default). GNU Info reads the binary file at startup to override the default key bindings and variable definitions. Synopsis: infokey [OPTION...] [INPUT-FILE] Besides the standard `--help' and `--version', the only option is `--output FILE'. This tells `infokey' to write the binary data to FILE instead of `$HOME/.info'. ---------- Footnotes ---------- (1) This file is named `_infokey' in the MS-DOS version, and is looked for in the current directory if `HOME' is undefined.  File: info-stnd.info, Node: infokey source format, Prev: Invoking infokey, Up: Custom Key Bindings `infokey' source format ======================= The format of the source file read by `infokey' is most easily illustrated by example. For instance, here is a sample `.infokey' source file suitable for aficionados of `vi' or `less': #info j next-line k prev-line l forward-char h backward-char \kd next-line \ku prev-line \kr forward-char \kl backward-char \ scroll-forward \kD scroll-forward-page-only b scroll-backward \kU scroll-backward-page-only g beginning-of-node \kh beginning-of-node G end-of-node \ke end-of-node \t select-reference-this-line - history-node n next-node p prev-node u up-node t top-node d dir-node #var scroll-step=1 The source file consists of one or more "sections". Each section starts with a line that identifies the type of section. Possible sections are: `#info' Key bindings for Info windows. The start of this section is indicated by a line containing just `#info' by itself. If this is the first section in the source file, the `#info' line can be omitted. The rest of this section consists of lines of the form: STRING whitespace ACTION [ whitespace [ # comment ] ] newline Whitespace is any sequence of one or more spaces and/or tabs. Comment is any sequence of any characters, excluding newline. STRING is the key sequence which invokes the action. ACTION is the name of an Info command. The characters in STRING are interpreted literally or prefixed by a caret (`^') to indicate a control character. A backslash followed by certain characters specifies input keystrokes as follows: `\b' Backspace `\e' Escape (ESC) `\n' Newline `\r' Return `\t' Tab `\ku' Up arrow `\kd' Down arrow `\kl' Left arrow `\kr' Right arrow `\kU' Page Up `\kD' Page Down `\kh' HOME `\ke' END `\kx' Delete (DEL) `\mX' Meta-X where X is any character as described above. Backslash followed by any other character indicates that character is to be taken literally. Characters which must be preceded by a backslash include caret, space, tab, and backslash itself. `#echo-area' Key bindings for the echo area. The start of this section is indicated by a line containing just `#echo-area' by itself. The rest of this section has a syntax identical to that for the key definitions for the Info area, described above. `#var' Variable initializations. The start of this section is indicated by a line containing just `#var' by itself. Following this line is a list of variable assignments, one per line. Each line consists of a variable name (*Note Variables::,) followed by `=' followed by a value. There may be no white space between the variable name and the `=', and all characters following the `=', including white space, are included in the value. Blank lines and lines starting with `#' are ignored, except for the special section header lines. Key bindings defined in the `.info' file take precedence over GNU Info's default key bindings, whether or not `--vi-keys' is used. A default key binding may be disabled by overriding it in the `.info' file with the action `invalid'. In addition, _all_ default key bindings can be disabled by adding this line _anywhere_ in the relevant section: #stop This will cause GNU Info to ignore all the default key commands for that section. Beware: `#stop' can be dangerous. Since it disables all default key bindings, you must supply enough new key bindings to enable all necessary actions. Failure to bind any key to the `quit' command, for example, can lead to frustration. The order in which key bindings are defined in the `.info' file is not important, except that the command summary produced by the `get-help-window' command only displays the _first_ key that is bound to each command.  File: info-stnd.info, Node: Index, Prev: Custom Key Bindings, Up: Top Index ***** * Menu: * ', vi-like operation: Node Commands. * ,: Searching Commands. * -: Miscellaneous Commands. * --subnodes, command line option: Invoking Info. * .info: Custom Key Bindings. * .infokey: Custom Key Bindings. * .infokey source format: infokey source format. * /: Searching Commands. * 0 ... 9, vi-like operation: Miscellaneous Commands. * 0, in Info windows: Selecting Xrefs. * 1 ... 9, in Info windows: Selecting Xrefs. * <: Node Commands. * >: Node Commands. * ?, in Info windows: Miscellaneous Commands. * ?, in the echo area: The Echo Area. * ?, vi-like operation: Searching Commands. * [: Node Commands. * ]: Node Commands. * _info file (MS-DOS): Custom Key Bindings. * _infokey file (MS-DOS): Invoking infokey. * abort-key: Miscellaneous Commands. * add-digit-to-numeric-arg: Miscellaneous Commands. * ANSI escape sequences in man pages: Invoking Info. * Apropos, in Info files: Invoking Info. * arguments, command line: Invoking Info. * arguments, negative: Miscellaneous Commands. * automatic-footnotes: Variables. * automatic-tiling: Variables. * b, in Info windows: Cursor Commands. * b, vi-like operation: Scrolling Commands. * BackTab, in Info windows: Selecting Xrefs. * BackTab, in the echo area: The Echo Area. * backward-char: Cursor Commands. * backward-word: Cursor Commands. * beginning-of-line: Cursor Commands. * beginning-of-node: Cursor Commands. * BS (backspace): Scrolling Commands. * C-a, in Info windows: Cursor Commands. * C-a, in the echo area: The Echo Area. * C-b, in Info windows: Cursor Commands. * C-b, in the echo area: The Echo Area. * C-b, vi-like operation: Scrolling Commands. * C-CENTER: Node Commands. * C-d, in the echo area: The Echo Area. * C-d, vi-like operation: Scrolling Commands. * C-e, in Info windows: Cursor Commands. * C-e, in the echo area: The Echo Area. * C-e, vi-like operation: Scrolling Commands. * C-End: Cursor Commands. * C-f, in Info windows: Cursor Commands. * C-f, in the echo area: The Echo Area. * C-f, vi-like operation: Scrolling Commands. * C-g, in Info windows: Miscellaneous Commands. * C-g, in the echo area: The Echo Area. * C-h: Miscellaneous Commands. * C-Home: Cursor Commands. * C-k, in the echo area: The Echo Area. * C-k, vi-like operation: Scrolling Commands. * C-l: Scrolling Commands. * C-LEFT: Cursor Commands. * C-LEFT, in the echo area: The Echo Area. * C-n: Cursor Commands. * C-n, vi-like operation: Scrolling Commands. * C-NEXT: Node Commands. * C-p: Cursor Commands. * C-p, vi-like operation: Scrolling Commands. * C-PgDn: Node Commands. * C-PgUp: Node Commands. * C-PREVIOUS: Node Commands. * C-q, in the echo area: The Echo Area. * C-r: Searching Commands. * C-RIGHT: Cursor Commands. * C-RIGHT, in the echo area: The Echo Area. * C-s: Searching Commands. * C-t, in the echo area: The Echo Area. * C-u: Miscellaneous Commands. * C-u cancels typeahead, vi-like operation: Miscellaneous Commands. * C-u, in the echo area, vi-like operation: The Echo Area. * C-u, vi-like operation: Scrolling Commands. * C-UP: Node Commands. * C-v: Scrolling Commands. * C-v, in the echo area, vi-like operation: The Echo Area. * C-w: Scrolling Commands. * C-x 0: Basic Windows. * C-x 1: Basic Windows. * C-x 2: Basic Windows. * C-x ^: Basic Windows. * C-x b: Node Commands. * C-x C-b: Node Commands. * C-x C-c: Miscellaneous Commands. * C-x C-f: Node Commands. * C-x DEL, in the echo area: The Echo Area. * C-x g, vi-like operation: Node Commands. * C-x k: Node Commands. * C-x n: Searching Commands. * C-x N: Searching Commands. * C-x n, vi-like operation: Node Commands. * C-x o: Basic Windows. * C-x r, vi-like operation: Selecting Xrefs. * C-x t: Basic Windows. * C-x u, vi-like operation: Node Commands. * C-y, in the echo area: The Echo Area. * C-y, vi-like operation: Scrolling Commands. * cancelling the current operation: Miscellaneous Commands. * cancelling typeahead: Miscellaneous Commands. * case-sensitive search: Searching Commands. * case-sensitivity, and search: Searching Commands. * colors in man pages: Invoking Info. * command line options: Invoking Info. * command-line options, how to find: Invoking Info. * commands, describing: Miscellaneous Commands. * completion: The Echo Area. * compressed Info files: Invoking Info. * cursor, moving: Cursor Commands. * customizing key bindings: Custom Key Bindings. * d: Node Commands. * d, vi-like operation: Scrolling Commands. * default key bindings, overriding: Custom Key Bindings. * DEL, in Info windows: Scrolling Commands. * DEL, in the echo area: The Echo Area. * delete-window: Basic Windows. * describe-command: Miscellaneous Commands. * describe-key: Miscellaneous Commands. * describe-variable: Variables. * dir-node: Node Commands. * directory path: Invoking Info. * DOWN (an arrow key): Cursor Commands. * DOWN, vi-like operation: Scrolling Commands. * down-line: Scrolling Commands. * e, in Info windows: Cursor Commands. * echo area: The Echo Area. * echo-area-abort: The Echo Area. * echo-area-backward: The Echo Area. * echo-area-backward-kill-line: The Echo Area. * echo-area-backward-kill-word: The Echo Area. * echo-area-backward-word: The Echo Area. * echo-area-beg-of-line: The Echo Area. * echo-area-complete: The Echo Area. * echo-area-delete: The Echo Area. * echo-area-end-of-line: The Echo Area. * echo-area-forward: The Echo Area. * echo-area-forward-word: The Echo Area. * echo-area-insert: The Echo Area. * echo-area-kill-line: The Echo Area. * echo-area-kill-word: The Echo Area. * echo-area-newline: The Echo Area. * echo-area-possible-completions: The Echo Area. * echo-area-quoted-insert: The Echo Area. * echo-area-rubout: The Echo Area. * echo-area-scroll-completions-window: The Echo Area. * echo-area-tab-insert: The Echo Area. * echo-area-transpose-chars: The Echo Area. * echo-area-yank: The Echo Area. * echo-area-yank-pop: The Echo Area. * End: Cursor Commands. * end-of-line: Cursor Commands. * end-of-node: Cursor Commands. * errors-ring-bell: Variables. * ESC C-f: Miscellaneous Commands. * ESC C-v, in Info windows: Basic Windows. * ESC C-v, in the echo area: The Echo Area. * f: Selecting Xrefs. * f, vi-like operation: Scrolling Commands. * F1: Miscellaneous Commands. * file names, relative: Invoking Info. * file, outputting to: Invoking Info. * files, compressed: Invoking Info. * find-menu: Selecting Xrefs. * finding the Invocation node: Node Commands. * first-node: Node Commands. * footnotes, displaying: Miscellaneous Commands. * format of .infokey source: infokey source format. * forward-char: Cursor Commands. * forward-word: Cursor Commands. * functions, describing: Miscellaneous Commands. * G: Node Commands. * g: Node Commands. * g, vi-like operation: Node Commands. * G, vi-like operation: Node Commands. * gc-compressed-files: Variables. * get-help-window: Miscellaneous Commands. * get-info-help-node: Miscellaneous Commands. * global-next-node: Node Commands. * global-prev-node: Node Commands. * goto-invocation: Node Commands. * goto-node: Node Commands. * grow-window: Basic Windows. * h: Miscellaneous Commands. * h, vi-like operation: Miscellaneous Commands. * history-node: Node Commands. * Home: Cursor Commands. * i: Searching Commands. * I: Node Commands. * incremental search: Searching Commands. * index search, selecting from the command line: Invoking Info. * index, searching: Searching Commands. * index-apropos: Searching Commands. * index-search: Searching Commands. * Info file, selecting: Invoking Info. * Info files, compressed: Invoking Info. * Info files, relative: Invoking Info. * Info files, searching all indices: Invoking Info. * Info, invoking: Invoking Info. * INFO_PRINT_COMMAND, environment variable: Printing Nodes. * infokey: Custom Key Bindings. * infokey source format: infokey source format. * infokey, invoking: Invoking infokey. * invocation description, how to find: Invoking Info. * invoking Info: Invoking Info. * invoking infokey: Invoking infokey. * isearch-backward: Searching Commands. * isearch-forward: Searching Commands. * ISO Latin characters: Variables. * ISO-Latin: Variables. * k, vi-like operation: Scrolling Commands. * keep-one-window: Basic Windows. * key bindings, customizing: Custom Key Bindings. * keys, describing: Miscellaneous Commands. * keystrokes, recording: Invoking Info. * kill-node: Node Commands. * l: Node Commands. * last-menu-item: Selecting Xrefs. * last-node: Node Commands. * LEFT (an arrow key): Cursor Commands. * LEFT, in the echo area: The Echo Area. * Less-like key bindings: Invoking Info. * LFD, vi-like operation: Scrolling Commands. * list-visited-nodes: Node Commands. * local printer device: Printing Nodes. * m: Selecting Xrefs. * M-$, vi-like operation: The Echo Area. * M--: Miscellaneous Commands. * M-0 ... M-9: Miscellaneous Commands. * M-0, in the echo area, vi-like operation: The Echo Area. * M-0, vi-like operation: Selecting Xrefs. * M-1 ... M-9, vi-like operation: Selecting Xrefs. * M-<: Cursor Commands. * M->: Cursor Commands. * M-b, in Info windows: Cursor Commands. * M-b, in the echo area: The Echo Area. * M-b, vi-like operation: Cursor Commands. * M-BS, in the echo area: The Echo Area. * M-d, in the echo area: The Echo Area. * M-d, vi-like operation: Node Commands. * M-DEL, in the echo area: The Echo Area. * M-f, in Info windows: Cursor Commands. * M-f, in the echo area: The Echo Area. * M-f, vi-like operation: Selecting Xrefs. * M-g, vi-like operation: Selecting Xrefs. * M-h, in the echo area, vi-like operation: The Echo Area. * M-h, vi-like operation: Miscellaneous Commands. * M-l, in the echo area, vi-like operation: The Echo Area. * M-r: Cursor Commands. * M-SPC, vi-like operation: Scrolling Commands. * M-t, vi-like operation: Node Commands. * M-TAB, in Info windows: Selecting Xrefs. * M-TAB, in the echo area: The Echo Area. * M-v: Scrolling Commands. * M-w, in the echo area, vi-like operation: The Echo Area. * M-x, in the echo area, vi-like operation: The Echo Area. * M-X, in the echo area, vi-like operation: The Echo Area. * M-y, in the echo area: The Echo Area. * menu, following: Invoking Info. * menu, following, from inside Info: Node Commands. * menu-digit: Selecting Xrefs. * menu-item: Selecting Xrefs. * menu-sequence: Node Commands. * move-to-next-xref: Selecting Xrefs. * move-to-prev-xref: Selecting Xrefs. * move-to-window-line: Cursor Commands. * moving the cursor: Cursor Commands. * n: Node Commands. * n, vi-like operation: Searching Commands. * negative arguments: Miscellaneous Commands. * NEXT: Scrolling Commands. * next-index-match: Searching Commands. * next-line: Cursor Commands. * next-node: Node Commands. * next-window: Basic Windows. * node, selecting from the command line: Invoking Info. * nodes, selection of: Node Commands. * numeric arguments: Miscellaneous Commands. * numeric arguments, negative: Miscellaneous Commands. * O: Node Commands. * online help, using Info as: Invoking Info. * options, command line: Invoking Info. * outputting to a file: Invoking Info. * overriding default key bindings: Custom Key Bindings. * p: Node Commands. * PageDown: Scrolling Commands. * PageUp: Scrolling Commands. * prev-line: Cursor Commands. * prev-node: Node Commands. * prev-window: Basic Windows. * PREVIOUS: Scrolling Commands. * print-node: Printing Nodes. * printing: Printing Nodes. * printing characters, in the echo area: The Echo Area. * printing nodes to the local printer: Printing Nodes. * q: Miscellaneous Commands. * quit: Miscellaneous Commands. * quitting: Miscellaneous Commands. * r: Selecting Xrefs. * redraw-display: Scrolling Commands. * relative Info file names: Invoking Info. * remembering user keystrokes: Invoking Info. * repeated search: Searching Commands. * replaying recorded keystrokes: Invoking Info. * RET, in Info windows: Selecting Xrefs. * RET, in the echo area: The Echo Area. * RET, vi-like operation: Scrolling Commands. * RIGHT (an arrow key): Cursor Commands. * RIGHT, in the echo area: The Echo Area. * s: Searching Commands. * S: Searching Commands. * screen, changing the height of: Miscellaneous Commands. * scroll-backward: Scrolling Commands. * scroll-backward-page-only: Scrolling Commands. * scroll-backward-page-only-set-window: Scrolling Commands. * scroll-behavior: Variables. * scroll-forward: Scrolling Commands. * scroll-forward-page-only: Scrolling Commands. * scroll-forward-page-only-set-window: Scrolling Commands. * scroll-half-screen-down: Scrolling Commands. * scroll-half-screen-up: Scrolling Commands. * scroll-other-window: Basic Windows. * scroll-step: Variables. * scrolling: Scrolling Commands. * scrolling through node structure: Scrolling Commands. * search: Searching Commands. * search, and case-sensitivity: Searching Commands. * search, case-sensitive: Searching Commands. * search-backward: Searching Commands. * search-case-sensitively: Searching Commands. * search-next: Searching Commands. * search-previous: Searching Commands. * searching: Searching Commands. * Searching all indices: Invoking Info. * searching, in the indices: Searching Commands. * select-reference-this-line: Selecting Xrefs. * select-visited-node: Node Commands. * set-screen-height: Miscellaneous Commands. * set-variable: Variables. * Shift-TAB, in Info windows: Selecting Xrefs. * Shift-TAB, in the echo area: The Echo Area. * show-footnotes: Miscellaneous Commands. * show-index-match: Variables. * SPC, in Info windows: Scrolling Commands. * SPC, in the echo area: The Echo Area. * speech synthesizers: Invoking Info. * split-window: Basic Windows. * t: Node Commands. * TAB, in Info windows: Selecting Xrefs. * TAB, in the echo area: The Echo Area. * tile-windows: Basic Windows. * tiling: Basic Windows. * toggle-wrap: Scrolling Commands. * top-node: Node Commands. * u: Node Commands. * u, vi-like operation: Scrolling Commands. * universal-argument: Miscellaneous Commands. * UP (an arrow key): Cursor Commands. * UP, vi-like operation: Scrolling Commands. * up-line: Scrolling Commands. * up-node: Node Commands. * variables, describing: Variables. * variables, setting: Variables. * version information: Invoking Info. * vi-like key bindings: Invoking Info. * view-file: Node Commands. * visible-bell: Variables. * w, vi-like operation: Scrolling Commands. * where-is: Miscellaneous Commands. * windows, creating: Basic Windows. * windows, deleting: Basic Windows. * windows, manipulating: Window Commands. * windows, selecting: Basic Windows. * xref-item: Selecting Xrefs. * y, vi-like operation: Scrolling Commands. * z, vi-like operation: Scrolling Commands. * ZZ, vi-like operation: Miscellaneous Commands. in the echo area: The Echo Area. * M-d, in the echo area: The Echo Area. * M-d, vi-like operation: Node Commands. * M-DEL, in the echo area: The Echo Area. * M-f, in Info windows: ./info/info.info 644 0 0 151757 7442531467 7001 This is info.info, produced by makeinfo version 4.1 from info.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Info: (info). Documentation browsing system. END-INFO-DIR-ENTRY This file describes how to use Info, the on-line, menu-driven GNU documentation system. Copyright (C) 1989, 92, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being "A GNU Manual", and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled "GNU Free Documentation License" in the Emacs manual. (a) The FSF's Back-Cover Text is: "You have freedom to copy and modify this GNU Manual, like GNU software. Copies published by the Free Software Foundation raise funds for GNU development." This document is part of a collection distributed under the GNU Free Documentation License. If you want to distribute this document separately from the collection, you can do so by adding a copy of the license to the document, as described in section 6 of the license.  File: info.info, Node: Top, Next: Getting Started, Up: (dir) Info: An Introduction ********************* Info is a program, which you are using now, for reading documentation of computer programs. The GNU Project distributes most of its on-line manuals in the Info format, so you need a program called "Info reader" to read the manuals. One of such programs you are using now. If you are new to Info and want to learn how to use it, type the command `h' now. It brings you to a programmed instruction sequence. To learn advanced Info commands, type `n' twice. This brings you to `Info for Experts', skipping over the `Getting Started' chapter. * Menu: * Getting Started:: Getting started using an Info reader. * Advanced Info:: Advanced commands within Info. * Creating an Info File:: How to make your own Info file. * Index:: An index of topics, commands, and variables.  File: info.info, Node: Getting Started, Next: Advanced Info, Prev: Top, Up: Top Getting Started *************** This first part of the Info manual describes how to get around inside of Info. The second part of the manual describes various advanced Info commands, and how to write an Info as distinct from a Texinfo file. The third part briefly explains how to generate Info files from Texinfo files. * Menu: * Help-Small-Screen:: Starting Info on a Small Screen * Help:: How to use Info * Help-P:: Returning to the Previous node * Help-^L:: The Space, DEL, B and ^L commands. * Help-M:: Menus * Help-Xref:: Following cross-references * Help-Int:: Some intermediate Info commands * Help-Q:: Quitting Info  File: info.info, Node: Help-Small-Screen, Next: Help, Up: Getting Started Starting Info on a Small Screen =============================== Since your terminal has a relatively small number of lines on its screen, it is necessary to give you special advice at the beginning. If you see the text `--All----' near the bottom right corner of the screen, it means the entire text you are looking at fits on the screen. If you see `--Top----' instead, it means that there is more text below that does not fit. To move forward through the text and see another screen full, press , the Space bar. To move back up, press the key labeled `Backspace' or `DEL' (on some keyboards, this key might be labeled `Delete'). Here are 40 lines of junk, so you can try and and see what they do. At the end are instructions of what you should do next. This is line 20 This is line 21 This is line 22 This is line 23 This is line 24 This is line 25 This is line 26 This is line 27 This is line 28 This is line 29 This is line 30 This is line 31 This is line 32 This is line 33 This is line 34 This is line 35 This is line 36 This is line 37 This is line 38 This is line 39 This is line 40 This is line 41 This is line 42 This is line 43 This is line 44 This is line 45 This is line 46 This is line 47 This is line 48 This is line 49 This is line 50 This is line 51 This is line 52 This is line 53 This is line 54 This is line 55 This is line 56 This is line 57 This is line 58 This is line 59 If you have managed to get here, go back to the beginning with `DEL' (or ), and come back here again, then you understand the about the `Space' and `Backspace' keys. So now type an `n' --just one character; don't type the quotes and don't type the Return key afterward-- to get to the normal start of the course.  File: info.info, Node: Help, Next: Help-P, Prev: Help-Small-Screen, Up: Getting Started How to use Info =============== You are talking to the program Info, for reading documentation. Right now you are looking at one "Node" of Information. A node contains text describing a specific topic at a specific level of detail. This node's topic is "how to use Info". The mode line says that this is node `Help' in the file `info'. The top line of a node is its "header". This node's header (look at it now) says that the `Next' node after this one is the node called `Help-P'. An advanced Info command lets you go to any node whose name you know. In the stand-alone Info reader program, the header line shows the names of this node and the info file as well. In Emacs, the header line is displayed in a special typeface, and it doesn't scroll off the screen when you scroll the display. The names of this node and of its Info file are omitted by Emacs from the header line. Besides a `Next', a node can have a `Previous' or an `Up' links, or both. As you can see, this node has all of these links. Now it is time to move on to the `Next' node, named `Help-P'. >> Type n to move there. Type just one character; do not type the quotes and do not type a afterward. `>>' in the margin means it is really time to try a command. >> If you have a mouse, and if you already practiced typing n to get to the next node, click now with the right mouse button on the `Next' link to do the same ``the mouse way''.  File: info.info, Node: Help-P, Next: Help-^L, Prev: Help, Up: Getting Started Returning to the Previous node ============================== This node is called `Help-P'. The `Previous' node, as you see, is `Help', which is the one you just came from using the `n' command. Another `n' command now would take you to the next node, `Help-^L'. In Emacs, `n' runs the Emacs command `Info-next', and `p' runs `Info-prev'. >> But do not type n yet. First, try the p command, or click the mouse on the `Prev' link, which takes you to the `Previous' node. When you get there, you can do an n again to return here. If you read this in Emacs, you will see an `Info' item in the menu bar, close to its right edge. Clicking your mouse on the `Info' menu-bar item opens a menu of commands which include `Next' and `Prev' (and also some others which you didn't yet learn about). This all probably seems insultingly simple so far, but _do not_ be led into skimming. Things will get more complicated soon. Also, do not try a new command until you are told it is time to. Otherwise, you may make Info skip past an important warning that was coming up. >> Now do an n, or click the mouse on the `Next' link, to get to the node `Help-^L' and learn more.  File: info.info, Node: Help-^L, Next: Help-M, Prev: Help-P, Up: Getting Started The Space, DEL, B and ^L commands. ================================== This node's mode line tells you that you are now at node `Help-^L', and the header line tells you that `p' would get you back to `Help-P'. The node's title is underlined; it says what the node is about (most nodes have titles). This is a big node and it does not all fit on your display screen. You can tell that there is more that is not visible because you can see the string `--Top-----' rather than `--All----' near the bottom right corner of the screen. The , (or )(1) and `b' commands exist to allow you to "move around" in a node that does not all fit on the screen at once. moves forward, to show what was below the bottom of the screen. or moves backward, to show what was above the top of the screen (there is not anything above the top until you have typed some spaces). In Emacs, runs the command `Info-scroll-up', while runs `Info-scroll-down'. >> Now try typing a (afterward, type a to return here). When you type the , the two lines that were at the bottom of the screen appear at the top, followed by more lines. or takes the two lines from the top and moves them to the bottom, _usually_, but if there are not a full screen's worth of lines above them they may not make it all the way to the bottom. If you are reading this in Emacs, note that the header line is always visible, never scrolling off the display. That way, you can always see the `Next', `Prev', and `Up' links, and you can conveniently go to one of these links from anywhere in the node by clicking the mouse on one of these links. and not only move forward and backward through the current node. When these keys hit the beginning or the end of the current node, they move to preceding or subsequent nodes. Specifically, they scroll through all the nodes in an Info file as a single logical sequence. In this sequence, a node's subnodes appear following their parent. If a node has a menu, takes you into the subnodes listed in the menu, one by one. Once you reach the end of a node, and have seen all of its subnodes, takes you to the next node or to the parent's next node. This is so you could read the entire manual top to bottom by just typing . Many keyboards nowadays have two scroll keys labeled `PageUp' and `PageDown' (or maybe `Prior' and `Next'). If your keyboard has these keys, you can use them to move forward and backward through the text, like with and . However, unlike and , and keys will never scroll beyond the beginning or the end of the current node. If your screen is ever garbaged, you can tell Info to display it again by typing `C-l' (`Control-L', that is--hold down and type `L' or `l'). >> Type C-l now. To move back to the beginning of the node you are on, you can type a lot of keys. You can also type simply `b' for beginning. >> Try that now. (We have put in enough verbiage to push this past the first screenful, but screens are so big nowadays that perhaps it isn't enough. You may need to shrink your Emacs or Info window.) Then come back, with s. If your screen is very tall, all of this node might fit at once. In that case, `b' won't do anything. Sorry; what can we do? You have just learned a considerable number of commands. If you want to use one but have trouble remembering which, you should type a `?' (in Emacs it runs the `Info-summary' command) which displays a brief list of commands. When you are finished looking at the list, make it go away by typing a repeatedly. >> Type a now. Press to see consecutive screenfuls of the list until finished. Then type several times, until it goes away. (If you are using the stand-alone Info reader, type `C-x 0' to return here, that is--press and hold , type an `x', then release and `x', and press `0'--a zero, not the letter "o".) From now on, you will encounter large nodes without warning, and will be expected to know how to use and to move around in them without being told. Since not all terminals have the same size screen, it would be impossible to warn you anyway. >> Now type n, or click the mouse on the `Next' link, to see the description of the m command. ---------- Footnotes ---------- (1) The key which we call "Backspace or DEL" in this manual is labeled differently on different keyboards. Look for a key which is a little ways above the or key and which you normally use outside Emacs to erase the character before the cursor, i.e. the character you typed last. It might be labeled `Backspace' or `<-' or `DEL', or sometimes `Delete'.  File: info.info, Node: Help-M, Next: Help-Xref, Prev: Help-^L, Up: Getting Started Menus and the `m' command ========================= With only the `n' (next) and `p' (previous) commands for moving between nodes, nodes are restricted to a linear sequence. Menus allow a branching structure. A menu is a list of other nodes you can move to. It is actually just part of the text of the node formatted specially so that Info can interpret it. The beginning of a menu is always identified by a line which starts with `* Menu:'. A node contains a menu if and only if it has a line in it which starts that way. The only menu you can use at any moment is the one in the node you are in. To use a menu in any other node, you must move to that node first. After the start of the menu, each line that starts with a `*' identifies one subtopic. The line usually contains a brief name for the subtopic (followed by a `:'), the name of the node that talks about that subtopic, and optionally some further description of the subtopic. Lines in the menu that do not start with a `*' have no special meaning--they are only for the human reader's benefit and do not define additional subtopics. Here is an example: * Foo: Node about FOO This tells about FOO The subtopic name is Foo, and the node describing it is `Node about FOO'. The rest of the line is just for the reader's Information. [[ But this line is not a real menu item, simply because there is no line above it which starts with `* Menu:'.]] When you use a menu to go to another node (in a way that will be described soon), what you specify is the subtopic name, the first thing in the menu line. Info uses it to find the menu line, extracts the node name from it, and goes to that node. The reason that there is both a subtopic name and a node name is that the node name must be meaningful to the computer and may therefore have to be ugly looking. The subtopic name can be chosen just to be convenient for the user to specify. Often the node name is convenient for the user to specify and so both it and the subtopic name are the same. There is an abbreviation for this: * Foo:: This tells about FOO This means that the subtopic name and node name are the same; they are both `Foo'. >> Now use to find the menu in this node, then come back to the front with a b and some s. As you see, a menu is actually visible in its node. If you cannot find a menu in a node by looking at it, then the node does not have a menu and the m command is not available. The command to go to one of the subnodes is `m'--but _do not do it yet!_ Before you use `m', you need to learn about commands which prompt you for more input. So far, you have learned several commands that do not need additional input; when you typed one, Info processed it and was instantly ready for another command. The `m' command is different: it is incomplete without the "name of the subtopic". Once you have typed `m', Info tries to read the subtopic name. Now look for the line containing many dashes near the bottom of the screen. There is one more line beneath that one, but usually it is blank. If it is empty, Info is ready for a command, such as `n' or `b' or or `m'. If that line contains text ending in a colon, it means Info is trying to read more input for the last command. At such times, commands do not work, because Info tries to use them as the input it needs. You must either type your response and finish the command you started, or type `Control-g' to cancel the command. When you have done one of those things, the line becomes blank again. The command to go to a subnode via a menu is `m'. After you type the `m', the line at the bottom of the screen says `Menu item: '. You must then type the name of the subtopic you want, and end it with a . In Emacs, `m' runs the command `Info-menu'. You can abbreviate the subtopic name. If the abbreviation is not unique, the first matching subtopic is chosen. Some menus put the shortest possible abbreviation for each subtopic name in capital letters, so you can see how much you need to type. It does not matter whether you use upper case or lower case when you type the subtopic. You should not put any spaces at the end, or inside of the item name, except for one space where a space appears in the item in the menu. You can also use the "completion" feature to help enter the subtopic name. If you type the key after entering part of a name, it will magically fill in more of the name--as much as follows uniquely from what you have entered. If you move the cursor to one of the menu subtopic lines, then you do not need to type the argument: you just type a , and it stands for the subtopic of the line you are on. Here is a menu to give you a chance to practice. This menu gives you three ways of going to one place, Help-FOO: * Menu: * Foo: Help-FOO. A node you can visit for fun. * Bar: Help-FOO. Strange! two ways to get to the same place. * Help-FOO:: And yet another! >> Now type just an m and see what happens: Now you are "inside" an `m' command. Commands cannot be used now; the next thing you will type must be the name of a subtopic. You can change your mind about doing the `m' by typing `Control-g'. >> Try that now; notice the bottom line clear. >> Then type another m. >> Now type BAR, the item name. Do not type yet. While you are typing the item name, you can use the (or ) key to cancel one character at a time if you make a mistake. >> Press to cancel the `R'. You could type another R to replace it. But you do not have to, since `BA' is a valid abbreviation. >> Now you are ready to go. Type a . After visiting `Help-FOO', you should return here. Another way to move to the menu subtopic lines and between them is to type . Each time you type a , you move to the next subtopic line. To move to a previous subtopic line, type `M-'--that is, press and hold the key and then press . (On some keyboards, the key might be labeled `Alt'.) Once you move cursor to a subtopic line, press to go to that subtopic's node. If your terminal supports a mouse, you have yet another way of going to a subtopic. Move your mouse pointer to the subtopic line, somewhere between the beginning `*' and the colon `:' which ends the subtopic's brief name. You will see the subtopic's name change its appearance (usually, its background color will change), and the shape of the mouse pointer will change if your platform supports that. After a while, if you leave the mouse on that spot, a tooltip will pop up saying "Mouse-2: go to that node". (If the tooltips are turned off or unavailable, this message is displayed in the "echo area", the bottom screen line where you typed the menu subtopics in response to the prompt.) `Mouse-2' is the second button of your mouse counting from the left--the rightmost button for two-button mice, the middle button for 3-button mice. So pressing `Mouse-2' while the mouse pointer is on a menu subtopic goes to that subtopic. More generally, `Mouse-2' in an Info buffer runs the Emacs command `Info-mouse-follow-nearest-node', which finds the nearest link to another node and goes there. For example, near a cross reference it acts like `f', in a menu it acts like `m', on the node's header line it acts like `n', `p', or `u', etc. At end of the node's text `Mouse-2' moves to the next node, or up if there's no next node. Here is another way to get to Help-FOO, a menu. You can ignore this if you want, or else try it by typing and then , or clicking `Mouse-2' on it (but then please come back to here). * Menu: * Help-FOO:: >> Type n to see more commands.  File: info.info, Node: Help-FOO, Up: Help-M The `u' command --------------- Congratulations! This is the node `Help-FOO'. It has an `Up' pointer `Help-M', the node you just came from via the `m' command. This is the usual convention--the nodes you reach from a menu have `Up' nodes that lead back to the menu. Menus move Down in the tree, and `Up' moves Up. `Previous', on the other hand, is usually used to "stay on the same level but go backwards". You can go back to the node `Help-M' by typing the command `u' for "Up" (the Emacs command run by `u' is `Info-up'). That puts you at the _front_ of the node--to get back to where you were reading you have to type some s. (Some Info readers, such as the one built into Emacs, put you at the same place where you were reading in `Help-M'.) Another way to go Up is to click on the `Up' pointer shown in the header line (provided that you have a mouse). >> Now type u to move back up to `Help-M'.  File: info.info, Node: Help-Xref, Next: Help-Int, Prev: Help-M, Up: Getting Started Following Cross-References ========================== In Info documentation, you will see many "cross references". Cross references look like this: *Note Cross: Help-Cross. That text is a real, live cross reference, whose name is `Cross' and which points to the node named `Help-Cross'. There are two ways to follow a cross reference. You can move the cursor to it and press , just as in a menu. follows the cross reference that the cursor is on. Or you can type `f' and then specify the name of the cross reference (in this case, `Cross') as an argument. In Emacs Info, `f' runs `Info-follow-reference', In the `f' command, you select the cross reference with its name, so it does not matter where the cursor was. If the cursor is on or near a cross reference, `f' suggests that reference name in parentheses as the default; typing will follow that reference. However, if you type a different reference name, `f' will follow the other reference which has that name. >> Type f, followed by Cross, and then . As you enter the reference name, you can use the (or ) key to edit your input. If you change your mind about following any reference, you can use `Control-g' to cancel the command. Completion is available in the `f' command; you can complete among all the cross reference names in the current node by typing a . To get a list of all the cross references in the current node, you can type `?' after an `f'. The `f' continues to await a cross reference name even after displaying the list, so if you don't actually want to follow a reference, you should type a `Control-g' to cancel the `f'. >> Type f? to get a list of the cross references in this node. Then type a Control-g and see how the `f' gives up. The and `M-' key, which move between menu items in a menu, also move between cross references outside of menus.  File: info.info, Node: Help-Int, Next: Help-Q, Prev: Help-Xref, Up: Getting Started Some intermediate Info commands =============================== The introductory course is almost over; please continue a little longer to learn some intermediate-level commands. Most Info files have an index, which is actually a large node that contains nothing but a menu. The menu has one menu item for each topic listed in the index. You can find the index node from the main menu of the file, with the `m' command; then you can use the `m' command again in the index node to go to the node that describes the topic. There is also a short-cut Info command, `i', which does all of that for you. It searches the index for a given topic (a string) and goes to the node which is listed in the index for that topic. *Note Info Search::, for a full explanation. If you have been moving around to different nodes and wish to retrace your steps, the `l' command (`l' for "last") will do that, one node-step at a time. As you move from node to node, Info records the nodes where you have been in a special history list. The `l' command revisits nodes in the history list; each successive `l' command moves one step back through the history. If you have been following directions, ad `l' command now will get you back to `Help-M'. Another `l' command would undo the `u' and get you back to `Help-FOO'. Another `l' would undo the `m' and get you back to `Help-M'. In Emacs, `l' runs the command `Info-last'. >> Try typing three l's, pausing in between to see what each l does. Then follow directions again and you will end up back here. Note the difference between `l' and `p': `l' moves to where _you_ last were, whereas `p' always moves to the node which the header says is the `Previous' node (from this node, the `Prev' link leads to `Help-M'). The `d' command (`Info-directory' in Emacs) gets you instantly to the Directory node. This node, which is the first one you saw when you entered Info, has a menu which leads (directly or indirectly, through other menus), to all the nodes that exist. The Directory node lists all the manuals and other Info documents that are, or could be, installed on your system. >> Try doing a d, then do an l to return here (yes, _do_ return). The `t' command moves to the `Top' node of the manual. This is useful if you want to browse the manual's main menu, or select some specific top-level menu item. The Emacs command run by `t' is `Info-top-node'. Clicking `Mouse-2' on or near a cross reference also follows the reference. You can see that the cross reference is mouse-sensitive by moving the mouse pointer to the reference and watching how the underlying text and the mouse pointer change in response. >> Now type n to see the last node of the course. *Note Advanced Info::, for more advanced Info features.  File: info.info, Node: Advanced Info, Next: Creating an Info File, Prev: Getting Started, Up: Top Info for Experts **************** This chapter describes various advanced Info commands. (If you are using a stand-alone Info reader, there are additional commands specific to it, which are documented in several chapters of *Note GNU Info: (info-stnd)Top.) This chapter also explains how to write an Info as distinct from a Texinfo file. (However, in most cases, writing a Texinfo file is better, since you can use it _both_ to generate an Info file and to make a printed manual. *Note Overview of Texinfo: (texinfo)Top.) * Menu: * Expert:: Advanced Info commands: g, s, e, and 1 - 5. * Info Search:: How to search Info documents for specific subjects. * Add:: Describes how to add new nodes to the hierarchy. Also tells what nodes look like. * Menus:: How to add to or create menus in Info nodes. * Cross-refs:: How to add cross-references to Info nodes. * Tags:: How to make tags tables for Info files. * Checking:: Checking an Info File * Emacs Info Variables:: Variables modifying the behavior of Emacs Info.  File: info.info, Node: Expert, Next: Info Search, Up: Advanced Info Advanced Info Commands ====================== Here are some more Info commands that make it easier to move around. `g' goes to a node by name -------------------------- If you know a node's name, you can go there by typing `g', the name, and . Thus, `gTop' would go to the node called `Top' in this file. (This is equivalent to `t', see *Note Help-Int::.) `gExpert' would come back here. `g' in Emacs runs the command `Info-goto-node'. Unlike `m', `g' does not allow the use of abbreviations. But it does allow completion, so you can type to complete a partial node name. To go to a node in another file, you can include the file name in the node name by putting it at the front, in parentheses. Thus, `g(dir)Top' would go to the Info Directory node, which is the node `Top' in the Info file `dir'. Likewise, `g(emacs)Top' goes to the top node of the Emacs manual. The node name `*' specifies the whole file. So you can look at all of the current file by typing `g*' or all of any other file with `g(FILENAME)'. `1' - `9' choose a menu subtopic by its number ---------------------------------------------- If you begrudge each character of type-in which your system requires, you might like to use the commands `1', `2', `3', `4', ..., `9'. They are short for the `m' command together with a name of a menu subtopic. `1' goes through the first item in the current node's menu; `2' goes through the second item, etc. In the stand-alone reader, `0' goes through the last menu item; this is so you need not count how many entries are there. In Emacs, the digit keys run the command `Info-nth-menu-item'. If your display supports multiple fonts, and you are using Emacs' Info mode to read Info files, the `*' for the fifth menu item stands out, either in color or in some other attribute, such as underline, and so is the `*' for the ninth item; this makes it easy to see at a glance which number to use for an item. Some terminals don't support colors or underlining. If you need to actually count items, it is better to use `m' instead, and specify the name, or use to quickly move between menu items. `e' makes Info document editable -------------------------------- The Info command `e' changes from Info mode to an ordinary Emacs editing mode, so that you can edit the text of the current node. Type `C-c C-c' to switch back to Info. The `e' command is allowed only if the variable `Info-enable-edit' is non-`nil'. The `e' command only works in Emacs, where it runs the command `Info-edit'. The stand-alone Info reader doesn't allow you to edit the Info file, so typing `e' there goes to the end of the current node.  File: info.info, Node: Info Search, Next: Add, Prev: Expert, Up: Advanced Info How to search Info documents for specific subjects ================================================== The commands which move between and inside nodes allow you to read the entire manual or its large portions. But what if you need to find some information in the manual as fast as you can, and you don't know or don't remember in what node to look for it? This need arises when you use a manual as a "reference", or when it is impractical to read the entire manual before you start using the programs it describes. Info has powerful searching facilities that let you find things quickly. You can search either the manual indices or its text. Since most subjects related to what the manual describes should be indexed, you should try the index search first. The `i' command prompts you for a subject and then looks up that subject in the indices. If it finds an index entry with the subject you typed, it goes to the node to which that index entry points. You should browse through that node to see whether the issue you are looking for is described there. If it isn't, type `,' one or more times to go through additional index entries which match your subject. The `i' command finds all index entries which include the string you typed _as a substring_. For each match, Info shows in the echo area the full index entry it found. Often, the text of the full index entry already gives you enough information to decide whether it is relevant to what you are looking for, so we recommend that you read what Emacs shows in the echo are before looking at the node it displays. Since `i' looks for a substring, you can search for subjects even if you are not sure how they are spelled in the index. For example, suppose you want to find something that is pertinent to commands which complete partial input (e.g., when you type ). If you want to catch index entries that refer to "complete", "completion", and "completing", you could type `icomplet'. Info documents which describe programs should index the commands, options, and key sequences that the program provides. If you are looking for a description of a command, an option, or a key, just type their names when `i' prompts you for a topic. For example, if you want to read the description of what the `C-f' key does, type `iC-f'. Here `C-f' are 3 literal characters `C', `-', and `f', not the "Control-f" command key you type inside Emacs to run the command bound to `C-f'. In Emacs, `i' runs the command `Info-index'. The `s' command allows you to search a whole file for a string. It switches to the next node if and when that is necessary. You type `s' followed by the string to search for, terminated by . To search for the same string again, just `s' followed by will do. The file's nodes are scanned in the order they are in in the file, which has no necessary relationship to the order that they may be in the tree structure of menus and `next' pointers. But normally the two orders are not very different. In any case, you can always do a `b' to find out what node you have reached, if the header is not visible (this can happen, because `s' puts your cursor at the occurrence of the string, not at the beginning of the node). In Emacs, `Meta-s' is equivalent to `s'. That is for compatibility with other GNU packages that use `M-s' for a similar kind of search command. Both `s' and `M-s' run in Emacs the command `Info-search'.  File: info.info, Node: Add, Next: Menus, Prev: Info Search, Up: Advanced Info Adding a new node to Info ========================= To add a new topic to the list in the Info directory, you must: 1. Create some nodes, in some file, to document that topic. 2. Put that topic in the menu in the directory. *Note Menu: Menus. Usually, the way to create the nodes is with Texinfo (*note Overview of Texinfo: (texinfo)Top.); this has the advantage that you can also make a printed manual from them. However, if you want to edit an Info file, here is how. The new node can live in an existing documentation file, or in a new one. It must have a `^_' character before it (invisible to the user; this node has one but you cannot see it), and it ends with either a `^_', a `^L' ("formfeed"), or the end of file.(1) The `^_' starting a node must be followed by a newline or a `^L' newline, after which comes the node's header line. The header line must give the node's name (by which Info finds it), and state the names of the `Next', `Previous', and `Up' nodes (if there are any). As you can see, this node's `Up' node is the node `Top', which points at all the documentation for Info. The `Next' node is `Menus'. The keywords "Node", "Next", "Previous", and "Up" may appear in any order, anywhere in the header line, but the recommended order is the one in this sentence. Each keyword must be followed by a colon, spaces and tabs, and then the appropriate name. The name may be terminated with a tab, a comma, or a newline. A space does not end it; node names may contain spaces. The case of letters in the names is insignificant. A node name has two forms. A node in the current file is named by what appears after the `Node: ' in that node's first line. For example, this node's name is `Add'. A node in another file is named by `(FILENAME)NODE-WITHIN-FILE', as in `(info)Add' for this node. If the file name starts with "./", then it is relative to the current directory; otherwise, it is relative starting from the standard directory for Info files of your site. The name `(FILENAME)Top' can be abbreviated to just `(FILENAME)'. By convention, the name `Top' is used for the "highest" node in any single file--the node whose `Up' points out of the file. The `Directory' node is `(dir)', it points to a file `dir' which holds a large menu listing all the Info documents installed on your site. The `Top' node of a document file listed in the `Directory' should have an `Up: (dir)' in it. The node name `*' is special: it refers to the entire file. Thus, `g*' shows you the whole current file. The use of the node `*' is to make it possible to make old-fashioned, unstructured files into nodes of the tree. The `Node:' name, in which a node states its own name, must not contain a file name, since when Info searches for a node, it does not expect a file name to be there. The `Next', `Previous' and `Up' names may contain them. In this node, since the `Up' node is in the same file, it was not necessary to use one. Note that the nodes in this file have a file name in the header line. The file names are ignored by Info, but they serve as comments to help identify the node for the user. ---------- Footnotes ---------- (1) If you put in a `^L' to end a new node, be sure that there is a `^_' after it to start the next one, since `^L' cannot _start_ a node. Also, a nicer way to make a node boundary be a page boundary as well is to put a `^L' _right after_ the `^_'.  File: info.info, Node: Menus, Next: Cross-refs, Prev: Add, Up: Advanced Info How to Create Menus =================== Any node in the Info hierarchy may have a "menu"--a list of subnodes. The `m' command searches the current node's menu for the topic which it reads from the terminal. A menu begins with a line starting with `* Menu:'. The rest of the line is a comment. After the starting line, every line that begins with a `* ' lists a single topic. The name of the topic-what the user must type at the `m''s command prompt to select this topic--comes right after the star and space, and is followed by a colon, spaces and tabs, and the name of the node which discusses that topic. The node name, like node names following `Next', `Previous' and `Up', may be terminated with a tab, comma, or newline; it may also be terminated with a period. If the node name and topic name are the same, then rather than giving the name twice, the abbreviation `* NAME::' may be used (and should be used, whenever possible, as it reduces the visual clutter in the menu). It is considerate to choose the topic names so that they differ from each other very near the beginning--this allows the user to type short abbreviations. In a long menu, it is a good idea to capitalize the beginning of each item name which is the minimum acceptable abbreviation for it (a long menu is more than 5 or so entries). The nodes listed in a node's menu are called its "subnodes", and it is their "superior". They should each have an `Up:' pointing at the superior. It is often useful to arrange all or most of the subnodes in a sequence of `Next' and `Previous' pointers so that someone who wants to see them all need not keep revisiting the Menu. The Info Directory is simply the menu of the node `(dir)Top'--that is, node `Top' in file `.../info/dir'. You can put new entries in that menu just like any other menu. The Info Directory is _not_ the same as the file directory called `info'. It happens that many of Info's files live in that file directory, but they do not have to; and files in that directory are not automatically listed in the Info Directory node. Also, although the Info node graph is claimed to be a "hierarchy", in fact it can be _any_ directed graph. Shared structures and pointer cycles are perfectly possible, and can be used if they are appropriate to the meaning to be expressed. There is no need for all the nodes in a file to form a connected structure. In fact, this file has two connected components. You are in one of them, which is under the node `Top'; the other contains the node `Help' which the `h' command goes to. In fact, since there is no garbage collector, nothing terrible happens if a substructure is not pointed to, but such a substructure is rather useless since nobody can ever find out that it exists.  File: info.info, Node: Cross-refs, Next: Tags, Prev: Menus, Up: Advanced Info Creating Cross References ========================= A cross reference can be placed anywhere in the text, unlike a menu item which must go at the front of a line. A cross reference looks like a menu item except that it has `*note' instead of `*'. It _cannot_ be terminated by a `)', because `)''s are so often part of node names. If you wish to enclose a cross reference in parentheses, terminate it with a period first. Here are two examples of cross references pointers: *Note details: commands. (See *note 3: Full Proof.) _These are just examples._ The places they "lead to" do not really exist! * Menu: * Help-Cross:: Target of a cross-reference.  File: info.info, Node: Help-Cross, Up: Cross-refs The node reached by the cross reference in Info ----------------------------------------------- This is the node reached by the cross reference named `Cross'. While this node is specifically intended to be reached by a cross reference, most cross references lead to nodes that "belong" someplace else far away in the structure of an Info document. So you cannot expect this node to have a `Next', `Previous' or `Up' links pointing back to where you came from. In general, the `l' (el) command is the only way to get back there. >> Type l to return to the node where the cross reference was.  File: info.info, Node: Help-Q, Prev: Help-Int, Up: Getting Started Quitting Info ============= To get out of Info, back to what you were doing before, type `q' for "Quit". This runs `Info-exit' in Emacs. This is the end of the basic course on using Info. You have learned how to move in an Info document, and how to follow menus and cross references. This makes you ready for reading manuals top to bottom, as new users should do when they learn a new package. Another set of Info commands is useful when you need to find something quickly in a manual--that is, when you need to use a manual as a reference rather than as a tutorial. We urge you to make learn these search commands as well. If you want to do that now, follow this cross reference to *Note Info Search::. Yet another set of commands are meant for experienced users; you can find them by looking in the Directory node for documentation on Info. Finding them will be a good exercise in using Info in the usual manner. >> Type d to go to the Info directory node; then type mInfo and Return, to get to the node about Info and see what other help is available.  File: info.info, Node: Tags, Next: Checking, Prev: Cross-refs, Up: Advanced Info Tags Tables for Info Files ========================== You can speed up the access to nodes of a large Info file by giving it a tags table. Unlike the tags table for a program, the tags table for an Info file lives inside the file itself and is used automatically whenever Info reads in the file. To make a tags table, go to a node in the file using Emacs Info mode and type `M-x Info-tagify'. Then you must use `C-x C-s' to save the file. Info files produced by the `makeinfo' command that is part of the Texinfo package always have tags tables to begin with. Once the Info file has a tags table, you must make certain it is up to date. If you edit an Info file directly (as opposed to editing its Texinfo source), and, as a result of deletion of text, any node moves back more than a thousand characters in the file from the position recorded in the tags table, Info will no longer be able to find that node. To update the tags table, use the `Info-tagify' command again. An Info file tags table appears at the end of the file and looks like this: ^_^L Tag Table: File: info, Node: Cross-refs^?21419 File: info, Node: Tags^?22145 ^_ End Tag Table Note that it contains one line per node, and this line contains the beginning of the node's header (ending just after the node name), a `DEL' character, and the character position in the file of the beginning of the node.  File: info.info, Node: Checking, Next: Emacs Info Variables, Prev: Tags, Up: Advanced Info Checking an Info File ===================== When creating an Info file, it is easy to forget the name of a node when you are making a pointer to it from another node. If you put in the wrong name for a node, this is not detected until someone tries to go through the pointer using Info. Verification of the Info file is an automatic process which checks all pointers to nodes and reports any pointers which are invalid. Every `Next', `Previous', and `Up' is checked, as is every menu item and every cross reference. In addition, any `Next' which does not have a `Previous' pointing back is reported. Only pointers within the file are checked, because checking pointers to other files would be terribly slow. But those are usually few. To check an Info file, do `M-x Info-validate' while looking at any node of the file with Emacs Info mode.  File: info.info, Node: Emacs Info Variables, Prev: Checking, Up: Advanced Info Emacs Info-mode Variables ========================= The following variables may modify the behavior of Info-mode in Emacs; you may wish to set one or several of these variables interactively, or in your `~/.emacs' init file. *Note Examining and Setting Variables: (emacs)Examining. The stand-alone Info reader program has its own set of variables, described in *Note Manipulating Variables: (info-stnd)Variables. `Info-directory-list' The list of directories to search for Info files. Each element is a string (directory name) or `nil' (try default directory). If not initialized Info uses the environment variable `INFOPATH' to initialize it, or `Info-default-directory-list' if there is no `INFOPATH' variable in the environment. If you wish to customize the Info directory search list for both Emacs info and stand-alone Info, it is best to set the `INFOPATH' environment variable, since that applies to both programs. `Info-additional-directory-list' A list of additional directories to search for Info documentation files. These directories are not searched for merging the `dir' file. `Info-fontify' When set to a non-`nil' value, enables highlighting of Info files. The default is `t'. You can change how the highlighting looks by customizing the faces `info-node', `info-menu-5', `info-xref', `info-header-xref', `info-header-node', `info-title-N-face' (where N is the level of the section, a number between 1 and 4), and `info-menu-header'. To customize a face, type `M-x customize-face FACE ', where FACE is one of the face names listed here. `Info-use-header-line' If non-`nil', Emacs puts in the Info buffer a header line showing the `Next', `Prev', and `Up' links. A header line does not scroll with the rest of the buffer, making these links always visible. `Info-scroll-prefer-subnodes' If set to a non-`nil' value, and (or ) keys in a menu visit subnodes of the current node before scrolling to its end or beginning, respectively. For example, if the node's menu appears on the screen, the next moves to a subnode indicated by the following menu item. Setting this option to `nil' results in behavior similar to the stand-alone Info reader program, which visits the first subnode from the menu only when you hit the end of the current node. The default is `t'. `Info-enable-active-nodes' When set to a non-`nil' value, allows Info to execute Lisp code associated with nodes. The Lisp code is executed when the node is selected. The Lisp code to be executed should follow the node delimiter (the `DEL' character) and an `execute: ' tag, like this: ^_execute: (message "This is an active node!") `Info-enable-edit' Set to `nil', disables the `e' (`Info-edit') command. A non-`nil' value enables it. *Note Edit: Add.  File: info.info, Node: Creating an Info File, Next: Index, Prev: Advanced Info, Up: Top Creating an Info File from a Texinfo File ***************************************** `makeinfo' is a utility that converts a Texinfo file into an Info file; `texinfo-format-region' and `texinfo-format-buffer' are GNU Emacs functions that do the same. *Note Overview of Texinfo: (texinfo)Top, to learn how to write a Texinfo file. *Note Creating an Info File: (texinfo)Creating an Info File, to learn how to create an Info file from a Texinfo file. *Note Installing an Info File: (texinfo)Installing an Info File, to learn how to install an Info file after you have created one.  File: info.info, Node: Index, Prev: Creating an Info File, Up: Top Index ***** This is an alphabetical listing of all the commands, variables, and topics discussed in this document. * Menu: * 1 through 9 (Info mode): Expert. * ? (Info mode): Help-^L. * abbreviating Info subnodes: Help-M. * b (Info mode): Help-^L. * BACKSPACE (Info mode): Help-^L. * C-l (Info mode): Help-^L. * completion of Info node names: Help-M. * cross reference format: Cross-refs. * cross references in Info documents: Help-Xref. * d (Info mode): Help-Int. * DEL (Info mode): Help-^L. * Directory node: Add. * e (Info mode): Expert. * edit Info document: Expert. * f (Info mode): Help-Xref. * format of node headers: Add. * g (Info mode): Expert. * go to a node by name: Expert. * go to another Info file: Expert. * go to Directory node: Help-Int. * go to Top node: Help-Int. * going back in Info mode: Help-Int. * header of Info node: Help. * i (Info mode): Info Search. * Info document as a reference: Info Search. * Info documents as tutorials: Help-^L. * Info menus: Help-M. * Info-additional-directory-list: Emacs Info Variables. * Info-directory: Help-Int. * Info-directory-list: Emacs Info Variables. * Info-edit: Expert. * Info-enable-active-nodes: Emacs Info Variables. * Info-enable-edit: Emacs Info Variables. * Info-exit: Help-Q. * Info-follow-reference: Help-Xref. * Info-fontify: Emacs Info Variables. * Info-goto-node: Expert. * Info-index: Info Search. * Info-last: Help-Int. * Info-menu: Help-M. * Info-mouse-follow-nearest-node: Help-M. * Info-nth-menu-item: Expert. * Info-scroll-down: Help-^L. * Info-scroll-prefer-subnodes: Emacs Info Variables. * Info-scroll-up: Help-^L. * Info-search: Info Search. * Info-summary: Help-^L. * Info-tagify: Tags. * Info-top-node: Help-Int. * Info-up: Help-FOO. * Info-use-header-line: Emacs Info Variables. * Info-validate: Checking. * l (Info mode): Help-Int. * m (Info mode): Help-M. * M-s (Info mode): Info Search. * menu and menu entry format: Menus. * menus in an Info document: Help-M. * mouse support in Info mode: Help-M. * Mouse-2 (Info mode): Help-M. * n (Info mode): Help. * node delimiters: Add. * node header line format: Add. * node name format: Add. * node, in Info documents: Help. * p (Info mode): Help-P. * PAGEDOWN (Info mode): Help-^L. * PAGEUP (Info mode): Help-^L. * q (Info mode): Help-Q. * quitting Info mode: Help-Q. * reading Info documents top to bottom: Help-^L. * s (Info mode): Info Search. * searching Info documents: Info Search. * select N'th menu item: Expert. * small screen, moving around: Help-Small-Screen. * SPC (Info mode): Help-^L. * stale tags tables: Tags. * t (Info mode): Help-Int. * tags tables in info files: Tags. * u (Info mode): Help-FOO. * unstructured documents: Add. * update Info tags table: Tags.  Tag Table: Node: Top1308 Node: Getting Started2259 Node: Help-Small-Screen3067 Node: Help4905 Node: Help-P6455 Node: Help-^L7732 Ref: Help-^L-Footnote-112333 Node: Help-M12706 Node: Help-FOO20610 Node: Help-Xref21585 Node: Help-Int23597 Node: Advanced Info26504 Node: Expert27756 Node: Info Search30553 Node: Add34112 Ref: Add-Footnote-137403 Node: Menus37656 Node: Cross-refs40526 Node: Help-Cross41299 Node: Help-Q41957 Node: Tags43114 Node: Checking44627 Node: Emacs Info Variables45580 Node: Creating an Info File48649 Node: Index49338  End Tag Table info-stnd)Variabl./info/dir 644 0 0 2164 7442532647 5616 This is the file .../info/dir, which contains the topmost node of the Info hierarchy, called (dir)Top. The first time you invoke Info you start off looking at this node.  File: dir, Node: Top This is the top of the INFO tree This (the Directory node) gives a menu of major topics. Typing "q" exits, "?" lists all Info commands, "d" returns here, "h" gives a primer for first-timers, "mEmacs" visits the Emacs manual, etc. In Emacs, you can click mouse button 2 on a menu item or cross reference to select it. * Menu: Texinfo documentation system * Info: (info). Documentation browsing system. * Texinfo: (texinfo). The GNU documentation format. * info standalone: (info-stnd). Read Info documents without Emacs. * infokey: (info-stnd)Invoking infokey. Compile Info customizations. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. stomize a face, type `M-x customize-face FACE ', where FACE is one of the face names listed here. `Info-use-header-line' If non-`nil', Emacs puts in the Info buffer a header line showing the `Next', `Prev', and `Up' links. A header line does not scroll with the rest of the buffer, making these links always visible. `Info-scroll-prefer-subnodes' If set to ./man/ 755 0 0 0 7442532656 4645 ./man/man1/ 755 0 0 0 7442532655 5500 ./man/man1/info.1 644 0 0 4253 7442526235 6603 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.24. .TH INFO "1" "March 2002" "GNU texinfo 4.1" FSF .SH NAME info \- read Info documents .SH SYNOPSIS .B info [\fIOPTION\fR]... [\fIMENU-ITEM\fR...] .SH DESCRIPTION Read documentation in Info format. .SH OPTIONS .TP \fB\-\-apropos\fR=\fISUBJECT\fR look up SUBJECT in all indices of all manuals. .TP \fB\-\-directory\fR=\fIDIR\fR add DIR to INFOPATH. .TP \fB\-\-dribble\fR=\fIFILENAME\fR remember user keystrokes in FILENAME. .TP \fB\-\-file\fR=\fIFILENAME\fR specify Info file to visit. .TP \fB\-\-help\fR display this help and exit. .TP \fB\-\-index\-search\fR=\fISTRING\fR go to node pointed by index entry STRING. .TP \fB\-\-node\fR=\fINODENAME\fR specify nodes in first visited Info file. .TP \fB\-\-output\fR=\fIFILENAME\fR output selected nodes to FILENAME. .TP \fB\-\-raw\-escapes\fR don't remove ANSI escapes from man pages. .TP \fB\-\-restore\fR=\fIFILENAME\fR read initial keystrokes from FILENAME. .TP \fB\-\-show\-options\fR, \fB\-\-usage\fR go to command-line options node. .TP \fB\-\-subnodes\fR recursively output menu items. .TP \fB\-\-vi\-keys\fR use vi-like and less-like key bindings. .TP \fB\-\-version\fR display version information and exit. .PP The first non-option argument, if present, is the menu entry to start from; it is searched for in all `dir' files along INFOPATH. If it is not present, info merges all `dir' files and shows the result. Any remaining arguments are treated as the names of menu items relative to the initial node visited. .SH EXAMPLES .TP info show top-level dir menu .TP info emacs start at emacs node from top-level dir .TP info emacs buffers start at buffers node within emacs manual .TP info \fB\-\-show\-options\fR emacs start at node with emacs' command line options .TP info \fB\-f\fR ./foo.info show file ./foo.info, not searching dir .SH "REPORTING BUGS" Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. .SH COPYRIGHT Copyright \(co 2002 Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. when the node is selected. The Lisp code to be executed should follow the node delimiter (the `DEL' character) and an `execute: ' tag, like this: ^_execute: (message "This is an active node!") `Info-enable-edit' Set to `nil', disables the `e' (`Info-edit') command. A non-`nil' value enables it. *Note Edi./man/man1/install-info.1 644 0 0 4447 7442526235 10254 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.24. .TH INSTALL-INFO "1" "March 2002" "GNU texinfo 4.1" FSF .SH NAME install-info \- update info/dir entries .SH SYNOPSIS .B install-info [\fIOPTION\fR]... [\fIINFO-FILE \fR[\fIDIR-FILE\fR]] .SH DESCRIPTION Install or delete dir entries from INFO-FILE in the Info directory file DIR-FILE. .SH OPTIONS .TP \fB\-\-delete\fR delete existing entries for INFO-FILE from DIR-FILE; don't insert any new entries. .TP \fB\-\-dir\-file\fR=\fINAME\fR specify file name of Info directory file. This is equivalent to using the DIR-FILE argument. .TP \fB\-\-entry\fR=\fITEXT\fR insert TEXT as an Info directory entry. TEXT should have the form of an Info menu item line plus zero or more extra lines starting with whitespace. If you specify more than one entry, they are all added. If you don't specify any entries, they are determined from information in the Info file itself. .TP \fB\-\-help\fR display this help and exit. .TP \fB\-\-info\-file\fR=\fIFILE\fR specify Info file to install in the directory. This is equivalent to using the INFO-FILE argument. .TP \fB\-\-info\-dir\fR=\fIDIR\fR same as \fB\-\-dir\-file\fR=\fIDIR\fR/dir. .TP \fB\-\-item\fR=\fITEXT\fR same as \fB\-\-entry\fR TEXT. An Info directory entry is actually a menu item. .TP \fB\-\-quiet\fR suppress warnings. .TP \fB\-\-remove\fR same as \fB\-\-delete\fR. .TP \fB\-\-section\fR=\fISEC\fR put this file's entries in section SEC of the directory. If you specify more than one section, all the entries are added in each of the sections. If you don't specify any sections, they are determined from information in the Info file itself. .TP \fB\-\-version\fR display version information and exit. .SH "REPORTING BUGS" Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. .SH COPYRIGHT Copyright \(co 2002 Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. .SH "SEE ALSO" The full documentation for .B install-info is maintained as a Texinfo manual. If the .B info and .B install-info programs are properly installed at your site, the command .IP .B info install-info .PP should give you access to the complete manual. , they are all added. If you don't specify any entries, they are determined from information in the Info file itself. .TP \fB\-\-help\fR display this help and exit. .TP \fB\-\-info\-file\fR=\fIFILE\fR specify Info fil./man/man1/makeinfo.1 644 0 0 10466 7442526235 7464 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.24. .TH MAKEINFO "1" "March 2002" "GNU texinfo 4.1" FSF .SH NAME makeinfo \- translate Texinfo documents .SH SYNOPSIS .B makeinfo [\fIOPTION\fR]... \fITEXINFO-FILE\fR... .SH DESCRIPTION Translate Texinfo source documentation to various other formats, by default Info files suitable for reading online with Emacs or standalone GNU Info. .SS "General options:" .TP \fB\-\-error\-limit\fR=\fINUM\fR quit after NUM errors (default 100). .TP \fB\-\-force\fR preserve output even if errors. .TP \fB\-\-help\fR display this help and exit. .TP \fB\-\-no\-validate\fR suppress node cross-reference validation. .TP \fB\-\-no\-warn\fR suppress warnings (but not errors). .TP \fB\-\-reference\-limit\fR=\fINUM\fR warn about at most NUM references (default 1000). .TP \fB\-v\fR, \fB\-\-verbose\fR explain what is being done. .TP \fB\-\-version\fR display version information and exit. .SS "Output format selection (default is to produce Info):" .TP \fB\-\-docbook\fR output DocBook rather than Info. .TP \fB\-\-html\fR output HTML rather than Info. .TP \fB\-\-no\-headers\fR output plain text, suppressing Info node separators and Node: lines; also, write to standard output without \fB\-\-output\fR. .TP \fB\-\-xml\fR output XML (TexinfoML) rather than Info. .SS "General output options:" .TP \fB\-E\fR, \fB\-\-macro\-expand\fR FILE output macro-expanded source to FILE. ignoring any @setfilename. .TP \fB\-\-no\-split\fR suppress splitting of Info or HTML output, generate only one output file. .TP \fB\-\-number\-sections\fR output chapter and sectioning numbers. .TP \fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR output to FILE (directory if split HTML), .SS "Options for Info and plain text:" .TP \fB\-\-enable\-encoding\fR output accented and special characters in Info output based on @documentencoding. .TP \fB\-\-fill\-column\fR=\fINUM\fR break Info lines at NUM characters (default 72). .TP \fB\-\-footnote\-style\fR=\fISTYLE\fR output footnotes in Info according to STYLE: `separate' to put them in their own node; `end' to put them at the end of the node .IP in which they are defined (default). .TP \fB\-\-paragraph\-indent\fR=\fIVAL\fR indent Info paragraphs by VAL spaces (default 3). If VAL is `none', do not indent; if VAL is `asis', preserve existing indentation. .TP \fB\-\-split\-size\fR=\fINUM\fR split Info files at size NUM (default 50000). .SS "Input file options:" .TP \fB\-\-commands\-in\-node\-names\fR allow @ commands in node names. .TP \fB\-D\fR VAR define the variable VAR, as with @set. .TP \fB\-I\fR DIR append DIR to the @include search path. .TP \fB\-P\fR DIR prepend DIR to the @include search path. .TP \fB\-U\fR VAR undefine the variable VAR, as with @clear. .SS "Conditional processing in input:" .TP \fB\-\-ifhtml\fR process @ifhtml and @html even if not generating HTML. .TP \fB\-\-ifinfo\fR process @ifinfo text even when generating HTML. .TP \fB\-\-iftex\fR process @iftex and @tex text; implies \fB\-\-no\-split\fR. .TP \fB\-\-no\-ifhtml\fR do not process @ifhtml and @html text. .TP \fB\-\-no\-ifinfo\fR do not process @ifinfo text. .TP \fB\-\-no\-iftex\fR do not process @iftex and @tex text. .IP The defaults for the @if... conditionals depend on the output format: if generating HTML, \fB\-\-ifhtml\fR is on and the others are off; if generating Info or plain text, \fB\-\-ifinfo\fR is on and the others are off. .SH EXAMPLES .TP makeinfo foo.texi write Info to foo's @setfilename .TP makeinfo \fB\-\-html\fR foo.texi write HTML to foo's @setfilename .TP makeinfo \fB\-\-no\-headers\fR \fB\-o\fR - foo.texi write plain text to standard output .TP makeinfo \fB\-\-number\-sections\fR foo.texi write Info with numbered sections .TP makeinfo \fB\-\-no\-split\fR foo.texi write one Info file however big .SH "REPORTING BUGS" Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. .SH COPYRIGHT Copyright \(co 2002 Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. .SH "SEE ALSO" The full documentation for .B makeinfo is maintained as a Texinfo manual. If the .B info and .B makeinfo programs are properly installed at your site, the command .IP .B info makeinfo .PP should give you access to the complete manual. to Directory node: Help-Int. * go to Top node: Help-Int. * going back in Info mode: Help-Int. * header of Info node: Help. * i (I./man/man1/texindex.1 644 0 0 2444 7442526235 7500 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.24. .TH TEXINDEX "1" "March 2002" "GNU texinfo 4.1" FSF .SH NAME texindex \- sort Texinfo index files .SH SYNOPSIS .B texindex [\fIOPTION\fR]... \fIFILE\fR... .SH DESCRIPTION Generate a sorted index for each TeX output FILE. Usually FILE... is specified as `foo.??' for a document `foo.texi'. .SH OPTIONS .TP \fB\-h\fR, \fB\-\-help\fR display this help and exit .TP \fB\-k\fR, \fB\-\-keep\fR keep temporary files around after processing .TP \fB\-\-no\-keep\fR do not keep temporary files around after processing (default) .TP \fB\-o\fR, \fB\-\-output\fR FILE send output to FILE .TP \fB\-\-version\fR display version information and exit .SH "REPORTING BUGS" Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. .SH COPYRIGHT Copyright \(co 2002 Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. .SH "SEE ALSO" The full documentation for .B texindex is maintained as a Texinfo manual. If the .B info and .B texindex programs are properly installed at your site, the command .IP .B info texindex .PP should give you access to the complete manual. eral output options:" .TP \fB\-E\fR, \fB\-\-macro\-expand\fR FILE output macro-expanded source to FILE. ignoring any @setfilename. .TP \fB\-\-no\-split\fR suppress splitting of Info or HTML output, generate only one outp./man/man1/texi2dvi.1 644 0 0 4751 7442526235 7411 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.24. .TH TEXI2DVI "1" "March 2002" "GNU Texinfo 4.1 0.47" FSF .SH NAME texi2dvi \- print Texinfo documents .SH SYNOPSIS .B texi2dvi [\fIOPTION\fR]... \fIFILE\fR... .SH DESCRIPTION Run each Texinfo or LaTeX FILE through TeX in turn until all cross-references are resolved, building all indices. The directory containing each FILE is searched for included files. The suffix of FILE is used to determine its language (LaTeX or Texinfo). .PP Makeinfo is used to perform Texinfo macro expansion before running TeX when needed. .SS "Operation modes:" .TP \fB\-b\fR, \fB\-\-batch\fR no interaction .TP \fB\-c\fR, \fB\-\-clean\fR remove all auxiliary files .TP \fB\-D\fR, \fB\-\-debug\fR turn on shell debugging (set \fB\-x\fR) .TP \fB\-h\fR, \fB\-\-help\fR display this help and exit successfully .TP \fB\-o\fR, \fB\-\-output\fR=\fIOFILE\fR leave output in OFILE (implies \fB\-\-clean\fR); Only one input FILE may be specified in this case .TP \fB\-q\fR, \fB\-\-quiet\fR no output unless errors (implies \fB\-\-batch\fR) .TP \fB\-s\fR, \fB\-\-silent\fR same as \fB\-\-quiet\fR .TP \fB\-v\fR, \fB\-\-version\fR display version information and exit successfully .TP \fB\-V\fR, \fB\-\-verbose\fR report on what is done .SS "TeX tuning:" .TP -@ use @input instead of \einput; for preloaded Texinfo .TP \fB\-e\fR, \fB\-\-expand\fR force macro expansion using makeinfo .TP \fB\-I\fR DIR search DIR for Texinfo files .TP \fB\-l\fR, \fB\-\-language\fR=\fILANG\fR specify the LANG of FILE (LaTeX or Texinfo) .TP \fB\-p\fR, \fB\-\-pdf\fR use pdftex or pdflatex for processing .TP \fB\-t\fR, \fB\-\-texinfo\fR=\fICMD\fR insert CMD after @setfilename in copy of input file multiple values accumulate .PP The values of the BIBTEX, LATEX (or PDFLATEX), MAKEINDEX, MAKEINFO, TEX (or PDFTEX), and TEXINDEX environment variables are used to run those commands, if they are set. .SH "REPORTING BUGS" Email bug reports to , general questions and discussion to . .SH COPYRIGHT Copyright \(co 2002 Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. .SH "SEE ALSO" The full documentation for .B texi2dvi is maintained as a Texinfo manual. If the .B info and .B texi2dvi programs are properly installed at your site, the command .IP .B info texi2dvi .PP should give you access to the complete manual. ble VAR, as with @set. ./man/man5/ 755 0 0 0 7442532660 5500 ./man/man5/info.5 644 0 0 3473 7442526235 6616 .\" info(5) .\" $Id: info.5,v 1.2 1998/07/31 17:39:31 karl Exp $ .\" .\" Copyright (C) 1998 Free Software Foundation, Inc. .\" .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of .\" this manual under the conditions for verbatim copying, provided that .\" the entire resulting derived work is distributed under the terms of a .\" permission notice identical to this one. .\" .\" Permission is granted to copy and distribute translations of this .\" manual into another language, under the above conditions for modified .\" versions, except that this permission notice may be stated in a .\" translation approved by the Foundation. .\" .TH INFO 5 "GNU Info" "FSF" .SH NAME info \- readable online documentation .SH DESCRIPTION The Info file format is an easily-parsable representation for online documents. It can be read by .I emacs(1) and .I info(1) among other programs. .PP Info files are usually created from .I texinfo(5) sources by .IR makeinfo(1) , but can be created from scratch if so desired. .PP For a full description of the Texinfo language and associated tools, please see the Texinfo manual (written in Texinfo itself). Most likely, running this command from your shell: .RS .I info texinfo .RE or this key sequence from inside Emacs: .RS .I M-x info RET m texinfo RET .RE will get you there. .SH AVAILABILITY ftp://ftp.gnu.org/pub/gnu/texinfo-.tar.gz .br or any GNU mirror site. .SH "REPORTING BUGS" Please send bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. .SH "SEE ALSO" info(1), install-info(1), makeinfo(1), texi2dvi(1), .br texindex(1). .br emacs(1), tex(1). .br texinfo(5). nment variables are used to run those commands, if they are set. .SH "REPORTING BUGS" Email bug reports to , general questions and discussion to . .SH COP./man/man5/texinfo.5 644 0 0 3315 7442526235 7332 .\" texinfo(5) .\" $Id: texinfo.5,v 1.3 1999/03/25 21:28:25 karl Exp $ .\" .\" Copyright (C) 1998, 99 Free Software Foundation, Inc. .\" .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of .\" this manual under the conditions for verbatim copying, provided that .\" the entire resulting derived work is distributed under the terms of a .\" permission notice identical to this one. .\" .\" Permission is granted to copy and distribute translations of this .\" manual into another language, under the above conditions for modified .\" versions, except that this permission notice may be stated in a .\" translation approved by the Foundation. .\" .TH TEXINFO 5 "GNU Texinfo" "FSF" .SH NAME Texinfo \- software documentation system .SH DESCRIPTION Texinfo is a documentation system that uses a single source file to produce both online information and printed output. It is primarily designed for writing software manuals. .PP For a full description of the Texinfo language and associated tools, please see the Texinfo manual (written in Texinfo itself). Most likely, running this command from your shell: .RS .I info texinfo .RE or this key sequence from inside Emacs: .RS .I M-x info RET m texinfo RET .RE will get you there. .SH AVAILABILITY ftp://ftp.gnu.org/gnu/texinfo/ .br or any GNU mirror site. .SH "REPORTING BUGS" Please send bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. .SH "SEE ALSO" info(1), install-info(1), makeinfo(1), texi2dvi(1), texindex(1). .br emacs(1), tex(1). .br info(5). this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of .\" this manual under the conditions for verbatim copying, provided that .\" the entire resulting derived work is distributed uR no output unless errors (implies \fB\-\-batch\fR) .TP \fB\-s\fR, \fB\-\-silent\fR same as \fB\-\-quiet\fR .TP \fB\-v\fR, \fB\-\-version\fR display version information and exit successfully .TP \fB\-V\fR, \fB\-\-verbose\fR report on what is done .SS "TeX tuning:" .TP -@ use @input instead of \einput; for preloaded Texinfo .TP \fB\-e\fR, \fB\-\-expand\fR force macro expansion using makeinfo .TP \fB\-I\fR DIR search DIR for Texinfo files .TP \fB\-l\fR, \fB\-\-language\fR=\fILANG\fR specify the LANG of FILE (LaTeX or Texinfo) .TP \fB\-p\fR, \fB\-\-pdf\fR use pdftex or pdflatex for processing .TP \fB\-t\fR, \fB\-\-texinfo\fR=\fICMD\fR insert CMD after @setfilename in copy of input file multiple values accumulate .PP The values of the BIBTEX, LATEX (or PDFLATEX), MAKEINDEX, MAKEINFO, TEX (or PDFTEX), and TEXINDEX environment variables are used to run those commands, if they are set. .SH "REPORTING BUGS" Email bug reports to , general questions and discussion to . .SH COPYRIGHT Copyright \(co 2002 Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. .SH "SEE ALSO" The full documentation for .B texi2dvi is maintained as a Texinfo manual. If the .B info and .B texi2dvi programs are properly installed at your site, the command .IP .B info texi2dvi .PP should give you access to the complete manual. ble VAR, as with @set. ./man/man5/ 755 0 0 0 7442532660 5500 ./man/man5/info.5 644 0 0 3473 7442526235 6616 .\" info(5) .\" $Id: info.5,v 1.2 1998/07/31 17:39:31 karl Exp $ .\" .\" Copyright (C) 1998 Free Software Foundation, Inc. .\" .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of .\" this manual under the conditions for verbatim copying, provided that .\" the entire resulting derived work is distributed under the terms of a .\" permission notice identical to this one. .\" .\" Permission is granted to copy and distribute translations of this .\" manual into another language, under the above conditions for modified .\" versions, except that this permission notice may be stated in a .\" translation approved by the Foundation. .\" .TH INFO 5 "GNU Info" "FSF" .SH NAME info \- readable online documentation .SH DESCRIPTION The Info file format is an easily-parsable representation for online documents. It can be read by .I emacs(1) and .I info(1) among other programs. .PP Info files are usually created from .I texinfo(5) sources by .IR makeinfo(1) , but can be created from scratch if so desired. .PP For a full description of the Texinfo language and associated tools, please see the Texinfo manual (written in Texinfo itself). Most likely, running this command from your shell: .RS .I info texinfo .RE or this key sequence from inside Emacs: .RS .I M-x info RET m texinfo RET .RE will get you there. .SH AVAILABILITY ftp://ftp.gnu.org/pub/gnu/texinfo-.tar.gz .br or any GNU mirror site. .SH "REPORTING BUGS" Please send bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org. .SH "SEE ALSO" info(1), install-info(1), makeinfo(1), texi2dvi(1), .br texindex(1). .br emacs(1), tex(1). .br texinfo(5). nment variables are used to run those commands, if they are set. .SH "REPORTING BUGS" Email bug reports to , general questions and discussion to . .SH COP./man/man5/texinfo.5 644 0 0 3315 7442526235 7332 .\" texinfo(5) .\" $Id: texinfo.5,v 1.3 1999/03/25 21:28:25 karl Exp $ .\" .\" Copyright (C) 1998, 99 Free Software Foundation, Inc. .\" .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of .\" this manual under the conditions for verbatim copying, provided that .\" the entire resulting derived work is distributed under the terms of a .\" permission notice identical to this one. .\" .\" Permission is granted to copy and distribute translations of this .\" manual into another language, under the above conditions for modified .\" versions, except that this permission notice may be stated in a .\" translation approved by the Foundation. .\" .TH TEXINFO 5 "GNU Texinfo" "FSF" .SH NAME Texinfo \- software documentation system .SH DESCRIPTION Texinfo is a documentation system that uses a single source file to produce both online information and printed output. It is primarily designed for writing software manuals. .PP For a full description of the Texinfo language and associated tools, please see the Texinfo manual (written in Texinfo itself). Most likely, running this command from your shell: .RS .I info texinfo .RE or this key sequence from inside Emacs: .RS .I M-x info RET m texinfo RET .RE will get you there. .SH AVAILABILITY ftp://ftp.gnu.org/gnu/texinfo/ .br or any GNU mirror site. .SH "REPORTING BUGS" Please send bug