fpc.sty.doc 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. fpc.sty defines the following:
  2. \procedure{name}{args}{desc}{errs}{seealso}
  3. \Procedure{name}{desc}{errs}{seealso}
  4. \function{name}{args}{return-type}{desc}{errs}{seealso}
  5. \Function{name}{return-type}{desc}{errs}{seealso}
  6. here is:
  7. name : the name of the function/procedure
  8. args : the (optional) arguments. type them between (), the sty doesn't add
  9. them.
  10. desc : the description of what it does. This can be very long.
  11. errs : possible errors, and what the function then does.
  12. seealso : info about related commands.
  13. Each procedure/punction call produces a subsection. it adds a label
  14. 'pro:name' or 'fu:name' and an index entry 'name'.
  15. then it gives the declaration as in the pascal file,
  16. it adds the description, the errors and see also, all in a list.
  17. the Capital letter commands are shorthands for if the function has no
  18. arguments (such as WhereX or so in crt.)
  19. So the above \function would produce:
  20. name (format of subsection)
  21. ------------------------------------
  22. Declaration: name args : return-type
  23. Description : desc
  24. Errors : errs
  25. See also : seealso
  26. The style redifines the \maketitle command, and adds a
  27. \description{Your description goes here}
  28. \version{Your version goes here}
  29. command, which produces something on the titlepage. (see the docs for
  30. examples)
  31. it also defines
  32. \var{arg}
  33. which typesets in \texttt its argument
  34. \seef{name}
  35. makes a cross reference (pageref) to function name (be careful about capitals).
  36. \seep{name}
  37. makes a cross reference (pageref) to procedure name..
  38. \seem{man}{sec}
  39. produces a reference to a UNIX man page. as in :
  40. man (sec)
  41. For nice typesetting it defines also \fpc, which nicely formats the name of
  42. the compiler.
  43. Then it defines also
  44. \linux
  45. \dos
  46. \msdos
  47. \ostwo
  48. \windowsnt
  49. \windows
  50. commands, which just typeset in small caps the name of the OS's...
  51. I think that's about it.
  52. Michael.