Annotation of 43BSDTahoe/ucb/lisp/doc/lmacs, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1980 Regents of the University of California.
                      2: .\" All rights reserved.  The Berkeley software License Agreement
                      3: .\" specifies the terms and conditions for redistribution.
                      4: .\"
                      5: .\"    @(#)lmacs       6.1 (Berkeley) 4/29/86
                      6: .\"
                      7: ." @(#)lmacs   34.4 3/23/82
                      8: ." $Header: lmacs 1.2 83/07/01 11:21:33 sklower Exp $
                      9: ."""""""
                     10: ." macros for the Franz Lisp Manual
                     11: ." 
                     12: ." first we set these global me variables
                     13: .""""""""
                     14: .nr ss 3v      \" space 4v between sections
                     15: ."" comment:
                     16: .nr si 3n      \" section indent
                     17: .""""""""
                     18: ." the following two lines are for larger type font
                     19: ." .nr pp 12
                     20: ." .nr sp 12
                     21: ." If we are making an on line manual, include the line below:
                     22: .if 0 .ll 7.5i \" extra wide for nroff, DISABLED
                     23: ."""""""""""""""
                     24: ."  A chapter is begun by
                     25: ."     .Lc chaptertitle number
                     26: ."
                     27: ." a function is introduced by a 
                     28: ."     .Lf functionname arglist
                     29: ." where the arglist must be one string, use "'s if necessary.
                     30: ." if there are two names for a function then the first is called with
                     31: ." .Lf and subsequent ones with .Lx
                     32: ." then there are these macros to begin text describing what the function
                     33: ." does:
                     34: ."     .Wh
                     35: ."     <text>                  says "WHERE" allowing you to give more
                     36: ."                             details on a function.
                     37: ."     .Re
                     38: ."     <text>                  tells what value the function returns
                     39: ."
                     40: ."     .No
                     41: ."     <text>                  begins a note, giving more detail on the fcn
                     42: ."
                     43: ."     .Se
                     44: ."     <text>                  describes a size effect of a function.
                     45: ."
                     46: ."     .Im
                     47: ."     <text>                  note to implementor. this will only be
                     48: ."                             printed out in the implementors version of
                     49: ."                             the manual.
                     50: ."     .Rm                     prints a message about this function being
                     51: ."                             likely to disappear
                     52: ."
                     53: ."     .Ex                     begin a short example
                     54: ."
                     55: ."     .Eb                     begin an large offset example
                     56: ."     .Ee                     end an example
                     57: ."
                     58: ."     .Fb                     begin a large offset example but don't
                     59: ."                             try to keep it on one page.
                     60: ."     .Fe                     end what .Fb started
                     61: ."
                     62: ." useful macros
                     63: ."     .Fr rest                prints out Franz Lisp and appends rest
                     64: ."                             to it.
                     65: ."
                     66: ." used in creating the index, table of contents and appendicies
                     67: ."                             
                     68: ."     .Ib                     begin index
                     69: ."     .In ch# pg# fcn-name fcn-args    this isnt inserted by hand, but
                     70: ."                             is generated by the index program. it indicates
                     71: ."                             where a function begins.
                     72: ."
                     73: ."     .Ap c T                 begin appendix c with title T
                     74: ."
                     75: .""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
                     76: .de Lc
                     77: ." .in 0
                     78: .++ RC '\\$1''\\\\\\\\\\\\\\\\n(ch-%'
                     79: .nr % 2
                     80: .nr ch \\$2-1
                     81: .+c \\$1
                     82: .fo '''\fR\s-2Printed:\ \*(td\s0\fP'
                     83: ..
                     84: .de Lf
                     85: .sp 1v
                     86: .ne 11
                     87: .Lx \\$1 "\\$2"
                     88: ..
                     89: .de Lx
                     90: .in 0
                     91: .ie '\\$2'' \fB(\\$1)\fP
                     92: .el \fB(\\$1\fP \\$2\fB)\fP
                     93: .br
                     94: .nr $i 5n
                     95: ." if troff, then put nice index entry, if nroff then we are making an
                     96: ." online manual so put out a cryptic lisp expression. If you want to
                     97: ." make an nroff version of the manual with index, then you will have
                     98: ." to alter the lines below: replace .if t with .if 1   and .if n with .if 0
                     99: .if t .tm .In \\n(ch \\n% \\$1 "\\$2"
                    100: .if n .tm (\\$1 ch\\n(ch.r)
                    101: ..
                    102: .de Re
                    103: .ip \s-2RETURNS\s0: 9
                    104: ..
                    105: .de Ex
                    106: .ip \s-2EXAMPLE\s0: 9
                    107: ..
                    108: .de No
                    109: .ip \s-2NOTE\s0: 6
                    110: ..
                    111: .de Eq
                    112: .ip \s-2EQUIVALENT\ TO\s0: 15
                    113: ..
                    114: .de Im
                    115: .ip \s-2IMPLEMENTATION\s0: 20
                    116: ..
                    117: .de Se
                    118: .ip \s-2SIDE\ EFFECT\s0: 13
                    119: ..
                    120: .de Wh
                    121: .ip \s-2WHERE\s0: 9
                    122: ..
                    123: .de Rm
                    124: .No
                    125: this function will most likely disappear in future releases.
                    126: ..
                    127: .de Fr
                    128: F\s-2RANZ\s0 L\s-2ISP\s0\\$1
                    129: ..
                    130: .de Ib \"      beginning of index
                    131: .Ap 1 Index\ to\ F\s-2RANZ\s0\ L\s-2ISP\s0\ Functions
                    132: .ta 6i \" set tab stop for location column
                    133: .tc .          \" generate dots to line up page numbers
                    134: .nf
                    135: ..
                    136: .de In
                    137: .ie '\\$4'' (\\fB\\$3\\fR)\t\\$1-\\$2
                    138: .el (\\fB\\$3\\fR\ \\$4)\t\\$1-\\$2
                    139: ..
                    140: .de Eb
                    141: .in 0
                    142: .(b 
                    143: .sp 1v
                    144: .hl
                    145: .sz -2
                    146: ..
                    147: .de Ee
                    148: .sz +2
                    149: .hl
                    150: .sp 1v
                    151: .)b
                    152: ..
                    153: .de Fb
                    154: .in 0
                    155: .sp 1v
                    156: .ne 1i
                    157: .hl
                    158: .sz -2
                    159: ..
                    160: .de Fe
                    161: .sz +2
                    162: .hl
                    163: .sp 1v
                    164: ..
                    165: .de Ap \" appendix n title  (n is 1 2 3 4  for A B C D etc)
                    166: .++ RA '''\\\\\\\\\\\\\\\\n(ch-%'
                    167: .nr ch \\$1-1
                    168: .+c \\$2
                    169: .fo '''\fR\s-2Printed:\ \*(td\s0\fP'
                    170: ..

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.