home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / cli / oscli10x.zoo / mandir / man.man < prev    next >
Encoding:
Text File  |  1990-10-15  |  2.0 KB  |  46 lines
  1. MAN
  2. ---
  3.  
  4. Syntax: MAN [level] command
  5.  
  6. Es wird die Datei 'command.*' aus einem der Directories, welche in der 
  7. Environmentvariablen MAN gespeichert sind, ausgegeben. Man kann sich so also
  8. ein oder mehrere Directories mit Hilfstexten (ASCII-codiert) anlegen,
  9. die jeweils die Endung '.MAN' tragen können.
  10. Wird dabei die optionale Zahl `level' angegeben, so sucht der CLI nach einer
  11. Extension, die mit dieser Zahl beginnt. Dabei darf sich `level' im Bereich
  12. Null bis Sieben bewegen. So könnte die Beschreibung für den C-Befehl
  13. `strcpy()' etwa `STRCPY.3C' heißen. Dabei steht die 3 für Level 3 und
  14. das `C' für die Programmiersprache C.
  15.  
  16. Man könnte also den Utilities und anderen Programmen Level 1, den
  17. Betriebssystemaufrufen den Level 2 und Bibliotheksfunktionen verschiedener
  18. Programmiersprachen den Level 3 zuordnen, wobei der drei noch ein Kennbuchstabe
  19. für die Programmiersprache nachgestellt wird.
  20.  
  21. Manchmal kann es sinnvoll sein, mehrere Hilfstexte in einer Datei abzulegen,
  22. die aber unter verschiedenen Namen angesprochen werden soll. So könnte man
  23. alle Stringbefehle in einer Datei 'STRING.3C' ablegen. Nun soll diese Datei
  24. auch unter den Namen 'strcpy', 'strcmp', 'strcat' u.s.w. angesprochen werden.
  25. Dazu wird eine Datei 'MAN.IDX' im Hilfstextdirectory angelegt, die pro Zeile
  26. einen Namen einer Datei zuordnet. Dabei beginnt eine Zeile mit dem Namen,
  27. unter dem die Datei angesprochen werden soll. Dann folgen ein oder
  28. mehrere Leerzeichen und schließlich der Dateiname.
  29. Die Datei könnte also z.B. so aussehen:
  30.  
  31. strcpy          string
  32. strcmp          string
  33. strcat          string
  34. fopen           gemfile
  35. fcreate         gemfile
  36.  
  37. Eine solche Indexdatei kann in jedem der in der MAN Environmentvariablen
  38. abgelegten Directories angelegt werden. Dabei bezieht sich jeder Dateiname
  39. auf das jeweilige Directory!
  40.  
  41. Normalerweise wird die Textdatei durch den internen MORE Befehl ausgegeben.
  42. Es kann dazu jedoch auch z.B. ein Programm benutzt werden. Dazu wird in
  43. der PAGER-Variablen der Name des Befehls abgelegt, der statt MORE die
  44. Datei ausgeben soll.
  45.  
  46.