xref: /original-bsd/old/lisp/PSD.doc/lmacs (revision 655593d0)
Copyright (c) 1980 The Regents of the University of California.
All rights reserved.

%sccs.include.redist.roff%

@(#)lmacs 6.2 (Berkeley) 04/17/91

." @(#)lmacs 34.4 3/23/82 ." $Header: lmacs 1.2 83/07/01 11:21:33 sklower Exp $ .""""""" ." macros for the Franz Lisp Manual ." ." first we set these global me variables ."""""""" .nr ss 3v \" space 4v between sections ."" comment: .nr si 3n \" section indent ."""""""" ." the following two lines are for larger type font ." .nr pp 12 ." .nr sp 12 ." If we are making an on line manual, include the line below: .""""""""""""""" ." A chapter is begun by ." .Lc chaptertitle number ." ." a function is introduced by a ." .Lf functionname arglist ." where the arglist must be one string, use "'s if necessary. ." if there are two names for a function then the first is called with ." .Lf and subsequent ones with .Lx ." then there are these macros to begin text describing what the function ." does: ." .Wh ." <text> says "WHERE" allowing you to give more ." details on a function. ." .Re ." <text> tells what value the function returns ." ." .No ." <text> begins a note, giving more detail on the fcn ." ." .Se ." <text> describes a size effect of a function. ." ." .Im ." <text> note to implementor. this will only be ." printed out in the implementors version of ." the manual. ." .Rm prints a message about this function being ." likely to disappear ." ." .Ex begin a short example ." ." .Eb begin an large offset example ." .Ee end an example ." ." .Fb begin a large offset example but don't ." try to keep it on one page. ." .Fe end what .Fb started ." ." useful macros ." .Fr rest prints out Franz Lisp and appends rest ." to it. ." ." used in creating the index, table of contents and appendicies ." ." .Ib begin index ." .In ch# pg# fcn-name fcn-args this isnt inserted by hand, but ." is generated by the index program. it indicates ." where a function begins. ." ." .Ap c T begin appendix c with title T ." ."""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" ." .in 0 .++ RC '\\$1''\\\\\\\\\\\\\\\\n(ch-%' .nr % 2 .nr ch \\$2-1 .+c \\$1 .fo '''\s-2Printed: \*(td\s0' .. .Lx \\$1 "\\$2" ..

.nr $i 5n ." if troff, then put nice index entry, if nroff then we are making an ." online manual so put out a cryptic lisp expression. If you want to ." make an nroff version of the manual with index, then you will have ." to alter the lines below: replace .if t with .if 1 and .if n with .if 0 .. .ip \s-2RETURNS\s0: 9 .. .ip \s-2EXAMPLE\s0: 9 .. .ip \s-2NOTE\s0: 6 .. .ip \s-2EQUIVALENT TO\s0: 15 .. .ip \s-2IMPLEMENTATION\s0: 20 .. .ip \s-2SIDE EFFECT\s0: 13 .. .ip \s-2WHERE\s0: 9 .. .No this function will most likely disappear in future releases. .. F\s-2RANZ\s0 L\s-2ISP\s0\\$1 .. .Ap 1 Index to F\s-2RANZ\s0 L\s-2ISP\s0 Functions .tc . \" generate dots to line up page numbers

..
..
.(b 
.hl
.sz -2
..
.sz +2
.hl
.)b
..
.hl
.sz -2
..
.sz +2
.hl
..
.++ RA '''\\\\\\\\\\\\\\\\n(ch-%'
.nr ch \\$1-1
.+c \\$2
.fo '''\s-2Printed: \*(td\s0'
..