| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame^] | 1 | NAME |
| 2 | about-efun+lfun-docs |
| 3 | |
| 4 | AUTHOR |
| 5 | These man pages were collected from the original 2.4.5 docs, |
| 6 | from the installed docs of NightFall, TubMud and MorgenGrauen. |
| 7 | |
| 8 | They were collected corrected and completed Pepel@NightFall, |
| 9 | with assistance and support by the LPC wizards of NightFall, |
| 10 | TubMud and MorgenGrauen, namely Hyp, Macbeth and Mateese. Also |
| 11 | to mention are Bumblebee, Boing, Deepthought, Demos, Hate and |
| 12 | Jof. |
| 13 | |
| 14 | DESCRIPTION |
| 15 | The man pages generally adhere to the following format, which |
| 16 | was inspired by the Unix man pages. |
| 17 | |
| 18 | <manpage> ::= <section>+ |
| 19 | |
| 20 | There are one or more sections in a man page. |
| 21 | |
| 22 | <section> ::= <section-name><newline><section-text><newline> |
| 23 | |
| 24 | The section names are always at the beginning of a line, and |
| 25 | in all capital letters (debatable uglyness). |
| 26 | |
| 27 | <section-name> ::= 'NAME' | 'CONCEPT' | 'SYNOPSIS' |
| 28 | | 'LAST UPDATED' |
| 29 | | 'DESCRIPTION' | 'AUTHOR' | 'BUGS' |
| 30 | | 'CAVEATS' | 'WARNING' | 'NOTE' | 'NOTES' |
| 31 | | 'EXAMPLE' | 'EXAMPLES' |
| 32 | | 'SEE ALSO' |
| 33 | |
| 34 | If a NAME section occurs, it should give the name of the man |
| 35 | page. |
| 36 | If a SYNOPSIS section occurs, the name of the man page canb be |
| 37 | derived from the function name, that appears in the line after |
| 38 | SYNOPSIS, which looks as follows: |
| 39 | |
| 40 | <returntype><space>['*']<function-name>'('<parameter-prototypes> |
| 41 | |
| 42 | SEE ALSO is followed by one or more lines that contain |
| 43 | crossreferences of the form |
| 44 | |
| 45 | <crossreferences> ::= |
| 46 | <crossref>[','<white-space><crossref>]*<white-space><EOF> |
| 47 | <crossref> ::= <man-page-name>'('<chapter-abbrev>')' |
| 48 | |
| 49 | The names of the referenced man pages are followed in brackets |
| 50 | by an abbreveiation for the chaper (i.e. directory) the man |
| 51 | page is in. The abbrevs are |
| 52 | E for efun/ the ``system calls'' of LPC |
| 53 | L for lfun/ member functions that the driver applies to objects |
| 54 | C for concepts/ general concepts of LPMUD and LPC |
| 55 | LPC for LPC/ about parts of the LPC language |
| 56 | M for master/ lfuns that are applied to the master object only |
| 57 | D for driver/ some info about internal operation of the driver |
| 58 | |
| 59 | If you want to process these man pages by some converter |
| 60 | program, you can use these to map the chapter names to file |
| 61 | names or whatever. |
| 62 | |
| 63 | BUGS |
| 64 | There are no man pages supported by Amylaar himself. |
| 65 | I hope one day I can convince him to at least put these docs |
| 66 | into the driver distribution. |
| 67 | |
| 68 | Meanwhile, please report any corrections / suggestions / |
| 69 | completions to <pepel@ibr.cs.tu-bs.de> |
| 70 | |
| 71 | SEE ALSO |
| 72 | efun(E), lfun(L), concepts(C), lpc(LPC), master(M), driver(D) |