home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d824 / pager.lha / Pager / Pager.dok < prev    next >
Text File  |  2001-02-25  |  7KB  |  216 lines
  1.  
  2.  
  3.  
  4.                            Dokumentation
  5.  
  6.  
  7.  
  8.                         Pager Version 1.0
  9.  
  10.  
  11.  
  12.  
  13.                   ® 1992/93 by H.P.G FreeWare
  14.  
  15.  
  16.  
  17. Index:
  18.  
  19.  
  20.  
  21.         Überblick
  22.         System Vorraussetzungen
  23.         Rechliches
  24.         Cli-Parameter
  25.         Beispiele
  26.         Technisches
  27.         Adresse
  28.         Liste der Dateien
  29.  
  30.  
  31. Überblick:
  32.  
  33.         Pager ist ein kleines Hilfprogramm, daß es dem Benutzer ermöglicht,
  34.         nachträglich Zeilen- und Seitennummerierungen in Texte und Dokumente
  35.         einzufügen.
  36.  
  37.         Pager ist eine Cli Programm und hat eine Reihe von Kommandozeilen-
  38.         optionen, die es dem Benutzer ermöglichen, die Form der Ausgabe zu
  39.         bestimmen.
  40.  
  41.         Die Formattierung des Textes wird dabei durch Kontrollzeichenketten
  42.         geregelt, die im Printf Style an Pager übergeben werden. Somit kann
  43.         man eine Zeichenkette, wie z.B. "%-3ld" zur Zeilennummerierung be-
  44.         nutzen.
  45.  
  46.         Außerdem kann noch die Anzahl der Zeilen pro Seite angegeben werden.
  47.  
  48.         Damit Pager auch in Batchdateien verwendet werden kann, besitzt es
  49.         eine Quiet-Option, die alle Ausgaben zum Cli-Fenster vermeidet.
  50.  
  51.  
  52.  
  53.  
  54. System Vorraussetzungen:
  55.  
  56.         Um Pager zu starten benötigt man mindestens OS 2.04. Unter äl-
  57.         teren Versionen wird Pager nicht laufen.
  58.  
  59.  
  60. Rechtliches:
  61.  
  62.  
  63.         Ich habe mich entschlossen dieses Programm und alle beigefügten
  64.         Dateien und Scripts, sowie aller Anleitungen, als FREEWARE   zu
  65.         deklarieren.
  66.  
  67.         D.h.:
  68.  
  69.             Jeder kann Pager benutzen.
  70.             Jeder darf Pager weitergeben, wenn:
  71.  
  72.                 1. Alle unten aufgeführten Programme mit  weitergegeben
  73.                    werden,
  74.  
  75.                 2. Keinerlei Veränderungen der unten aufgeführten  Pro-
  76.                    grammen (am Ende der Anleitung)  vorgenommen wurden,
  77.  
  78.                 3. Bei  Nachkompilierungen  der QuellCodes muß ein Hin-
  79.                    weis  auf  den  Orginalprogrammierer beigefügt sein,
  80.                    bei  Herausgabe  dieser,  muß  eine  Kopie  an  mich
  81.                    gesandt werden.
  82.  
  83.                 4. Pager darf nicht verkauft werden.
  84.  
  85.                        Außnahme: Es darf eine geringe  Kopiergebühr er-
  86.                                  hoben werden, die aber  5 DM  bzw. den
  87.                                  entsprechenden  Gegenwert  in  anderen
  88.                                  Währungen nicht übersteigt.
  89.  
  90.                 5. Pager  darf  nur als Teil eines kommerziellen Produktes
  91.                    herrausgegeben  werden,  mit ausdrücklicher schrift-
  92.                    licher Genehmigung des Autors (Adresse siehe unten).
  93.  
  94.                 Zuwiderhandlungen  der  oben  Aufgeführten  Konditionen
  95.                 werden Zivilrechtlich verfolgt.
  96.  
  97.  
  98.         Ferner  wird  für  die Funktion des Programmes ,sowie möglicher
  99.         Folgen  der  Benutzung  des Programmes sowie der u. a. Dateien,
  100.         keinerlei Gewährleistung übernommen.
  101.  
  102.         !!! Alle Risiken trägt der Benutzer allein !!!
  103.  
  104.  
  105.  
  106.  
  107. Cli-Parameter:
  108.  
  109.  
  110.     Pager versteht folgende Cli Optionen:
  111.  
  112.         Syntax: Pager <File/M/A><TO/A> [Numbers=N/K][PLen=P/K/N]
  113.                       [LnForm=L/K][Quiet=Q/S]
  114.  
  115.     wobei
  116.  
  117.  
  118.         File    = Das ist die Quelldatei, die Pager verändern soll. Dieses
  119.                   Argument muß angegeben werden. Man kann auch mehrere Quell-
  120.                   dateien angeben. In diesem Fall muß man aber aufpassen, daß
  121.                   man nicht vergißt auch eine Zieldatei anzugeben. Sonst wird
  122.                   nämlich die letzte Quelldatei als Zeildatei benutzt und so-
  123.                   mit überschrieben.
  124.  
  125.         To      = Dies ist die Zieldatei. Abhängig von den Einstellungen ent-
  126.                   hält diese Datei nun die Zeilen- und/oder Seitennummern.
  127.                   Quell und Zieldatei können nicht die gleiche sein.
  128.  
  129.         Numbers = Dies ist die Formatzeichenkette, die Pager für die Zeilen-
  130.                   nummerierung benutzen soll. Diese Zeichenkette muß irgendwo
  131.                   ein "%ld" enthalten. Allerdings kann man auch "%#ld" oder
  132.                   "%-#ld" benutzen, wobei # the Anzahl der Stellen der Zei-
  133.                   lennummern angibt. Ein - gibt die Auffüllrichtung der
  134.                   Zahlen an. Siehe auch printf, scanf Konventionen.
  135.  
  136.         PLen    = Diese Nummer gibt die Anzahl der Zeilen pro Seite an.
  137.                   Wird diese Nummer nicht angegeben benutzt Pager eiene
  138.                   Seitenlänge von 65 Zeilen pro Seite.
  139.  
  140.         LnForm  = Die ist die Formatzeichenkette, die für die Seitennummerie-
  141.                   rung benutzt wird. Hier kann man noch zusätzlich ein "%s"
  142.                   angeben, man muß aber wieder ein "%ld" irgendwo in der
  143.                   Zeichenkette angeben. Will man beide Ausdrücke angeben,
  144.                   muß das "%s" vor dem "%ld" erscheinen.
  145.  
  146.         Quiet   = Ist dieser Schalter angegeben, werden keine Informationen
  147.                   zum Cli Fenster gesandt.
  148.  
  149.  
  150. Beispiele:
  151.  
  152.  
  153.     Es folgen nun einige Beispiele um das Verhalten von Pager aufzu-
  154.     zeigen:
  155.  
  156.  
  157.         1. Hinzufügen von Zeilennummern zu der Textdatei mit dem Namen
  158.            MyText.asc. Der Text enthält ca. 500 Zeilen so können wir
  159.            eine 3 stellige Formattierungszeichenkette benutzen,
  160.  
  161.            SHELL 1.>  Pager MyText.asc to Ram:MyText.numbers.asc N "%3ld"
  162.  
  163.         2. Hinzufügen von Zeilen und Seitennummern nach jeder 55. Zeile.
  164.            The Zeilennummern sollen führende 0 haben und eine Länge von
  165.            5 Zeichen aufweisen.
  166.  
  167.            SHELL 1.>  Pager Source.c To Source.asc N "%05ld   : " P 55
  168.                             L "%s Now at page Number %ld"
  169.  
  170.         3. Hinzufpgen von Zeilennummern von drei Headerdateien. Außerdem
  171.            sollen noch Seitennummern eingefügt werden und es sollen keine
  172.            Informationen zum Cli-Fenster gesandt werden.
  173.  
  174.            SHELL 1.>  Pager Header1.h Header2.h Header3.h To
  175.                             Header.sample.list N "%3ld :" P "25"
  176.                             L "File: %s Page: %3ld" QUIET
  177.  
  178.  
  179.         Nach der Formattierung kann man die Zieldatei einfach ausdrucken.
  180.         Man kann aber auch als Zieldatei "PRT:" angeben, wobei dann der
  181.         formattierte Text direkt zum Drucker gesendet wird.
  182.  
  183.  
  184. Technisches:
  185.  
  186.         Pager ist in C mit dem Manx Aztec 5.2a Compiler System geschrieben
  187.         worden.
  188.  
  189.         Ich benutze die Formatzeichenketten direkt in Funktionsaufrufen
  190.         von Printf etc.
  191.  
  192. Adresse:
  193.  
  194.         Für alle Arten von Ideen, Geschgenken, Geld etc meine Adresse:
  195.  
  196.                 Hans-Peter Günther
  197.                 Grüner Weg 5
  198.                 W-3501 Fuldatal 2
  199.                 GERMANY
  200.  
  201.  
  202. Liste der Dateien:
  203.  
  204.         Dieses Paket sollte alle folgenden Dateien beinhalten.
  205.         Fehlt eine oder mehrere Dateien, so laßt es mich bitte wissen.
  206.  
  207.         Pager            :  das Programm
  208.         Pager.info       :
  209.         Pager.doc        :  englische Dokumentation
  210.         Pager.doc.info   :
  211.         Pager.dok        :  deutsche DoKumentation
  212.         Pager.dok.info   :
  213.  
  214.  
  215.  
  216.