Rheinwerk Computing < openbook > Rheinwerk Computing - Professionelle Bücher. Auch für Einsteiger.
Professionelle Bücher. Auch für Einsteiger.

Inhaltsverzeichnis
Vorwort
1 Einleitung
TEIL I: Einstieg in Linux
2 Die Installation
3 Erste Schritte
4 Linux als Workstation für Einsteiger
TEIL II: Grundlagen
5 Kernel
6 Grundlagen aus Anwendersicht
TEIL III: Die Shell
7 Die Shell
8 Reguläre Ausdrücke
9 Konsolentools
10 Die Editoren
11 Shellskriptprogrammierung mit der bash
12 Die C-Shell
TEIL IV: System- & Netzwerkadministration
13 Benutzerverwaltung
14 Grundlegende Verwaltungsaufgaben
15 Netzwerkgrundlagen
16 Anwendersoftware für das Netzwerk
17 Netzwerkdienste
18 Mailserver unter Linux
19 LAMP & Co.
20 DNS-Server
21 Secure Shell
TEIL V: Die grafische Oberfläche
22 Die grafische Oberfläche
23 Window-Manager und Desktops
24 X11-Programme
25 Multimedia und Spiele
TEIL VI: Systeminterna
26 Prozesse und IPC
27 Bootstrap und Shutdown
28 Dateisysteme
29 Virtualisierung und Emulatoren
TEIL VII: Programmierung und Sicherheit
30 Softwareentwicklung
31 Crashkurs in C und Perl
32 Einführung in Computersicherheit
33 Netzwerksicherheit überwachen
TEIL VIII: Anhang
A Lösungen zu den einzelnen Aufgaben
B Kommandoreferenz
C X11-InputDevices
D MBR
E Buch-DVDs
F Glossar
G Literatur
Stichwort
Ihre Meinung?

Spacer
Linux von Johannes Plötner, Steffen Wendzel
Das umfassende Handbuch
Buch: Linux

Linux
Rheinwerk Computing
1282 S., 5., aktualisierte Auflage 2012, geb., mit 2 DVDs
49,90 Euro, ISBN 978-3-8362-1822-1
Pfeil 30 Softwareentwicklung
Pfeil 30.1 Interpreter und Compiler
Pfeil 30.1.1 C und C++
Pfeil 30.1.2 Perl
Pfeil 30.1.3 Java
Pfeil 30.1.4 Tcl
Pfeil 30.1.5 Was es sonst noch gibt
Pfeil 30.2 Shared Libraries
Pfeil 30.2.1 Vorteile der Shared Libraries
Pfeil 30.2.2 Statisches Linken
Pfeil 30.2.3 Dateien
Pfeil 30.3 Debugging
Pfeil 30.3.1 Vorbereitung
Pfeil 30.3.2 Konsolenarbeit
Pfeil 30.3.3 DDD
Pfeil 30.4 Profiling
Pfeil 30.4.1 Compiler-Option
Pfeil 30.4.2 gprof verwenden
Pfeil 30.4.3 Profiling-Daten lesen
Pfeil 30.5 Tracing
Pfeil 30.6 Hilfe beim Finden von Bugs
Pfeil 30.6.1 ProPolice
Pfeil 30.6.2 Flawfinder und RATS
Pfeil 30.6.3 Electric Fence
Pfeil 30.7 Integrierte Entwicklungsumgebungen
Pfeil 30.8 Make
Pfeil 30.8.1 Makefile
Pfeil 30.8.2 Makros
Pfeil 30.8.3 Shellvariablen in Makefiles
Pfeil 30.8.4 Einzelne Targets übersetzen
Pfeil 30.8.5 Spezielle Targets
Pfeil 30.8.6 Tipps im Umgang mit Make
Pfeil 30.9 Die GNU Autotools
Pfeil 30.10 lex/flex und yacc/bison
Pfeil 30.10.1 flex grundlegend anwenden
Pfeil 30.10.2 bison/yacc grundlegend anwenden
Pfeil 30.11 Unix-Software veröffentlichen
Pfeil 30.12 Manpages erstellen
Pfeil 30.12.1 groff nutzen
Pfeil 30.12.2 Manpages installieren
Pfeil 30.13 Versionsmanagement
Pfeil 30.13.1 CVS
Pfeil 30.13.2 Subversion
Pfeil 30.13.3 Git
Pfeil 30.14 Wichtige Bibliotheken
Pfeil 30.14.1 Entwicklung grafischer Oberflächen
Pfeil 30.14.2 Weitere Bibliotheken
Pfeil 30.15 Zusammenfassung
Pfeil 30.16 Aufgaben

Rheinwerk Computing - Zum Seitenanfang

30.12 Manpages erstellenZur nächsten Überschrift

Neben einer vernünftigen Dokumentation, die als Textdatei, HTML, PDF oder als was auch immer vorliegen kann, ist es unter Unix und Linux üblich, für eigene Programme eine Manpage zu erstellen. Eine Manpage erklärt im Groben die Funktionsweise eines Programms und die Parameter, die man ihm übergeben kann.


Rheinwerk Computing - Zum Seitenanfang

30.12.1 groff nutzenZur nächsten ÜberschriftZur vorigen Überschrift

Zur Erstellung einer Manpage nutzt man das Tool groff. Dabei wird eine Textdatei erstellt, aus der groff anschließend eine Manpage erstellt.

Gearbeitet wird dabei ähnlich wie in \LaTeX{} oder HTML: Man verwendet verschiedene Befehle, die Formatierungsanweisungen für einen Interpreter/Compiler darstellen. Im Folgenden wollen wir Ihnen die wichtigsten Befehle vorstellen, die man zur Erstellung von Manpages mit groff verwendet.

  • .TH NAME SEKTION
    Dieser Befehl legt den Namen einer Manpage (in der Regel ist das der Name des Programms) sowie die Sektion fest, der sie angehört.
  • .SH NAME
    .SH
    leitet eine Manpage-Sektion (zum Beispiel NAME, AUTHOR oder DESCRIPTION) ein. Betrachten Sie einmal eine typische Manpage, um sich einen Überblick über häufig verwendete Sektionen zu verschaffen.
  • .RS
    Dieser Befehl bewirkt einen 7-Zeichen-Einschub gegenüber der vorhergehenden Zeile. So kann eine Manpage hierarchisch gegliedert und übersichtlicher gehalten werden.
  • .I
    Der .I-Befehl bewirkt, dass der Text einer Zeile unterstrichen oder kursiv gesetzt wird.
  • .IP
    Zur Aufzählung einzelner Parameter für ein Programm wird in der Regel der Befehl .IP verwendet. Hinter ihn setzt man den Parameter (also etwa -r) und in die darauffolgende Zeile die entsprechende Erklärung dazu.

Eine Manpage könnte in etwa folgendermaßen aussehen:

Listing 30.67 Eine exemplarische Manpage

.TH MeinTool 1
.SH NAME
MeinTool ein ganz prima feines Tool
.SH SYNOPSIS
.B MeinTool [-v] [-l
.I config-file
.B ]
.SH DESCRIPTION

MeinTool kann alles, was andere Tools nicht koennen.

.SH OPTIONS
.IP -v
Ausfuehrliche Meldungen ausgeben.
.IP "-l config-file"
Falls nicht die Standard-Konfigurationsdatei
verwendet werden soll, kann ueber diesen Parameter
eine Alternative (
.I config-file
) angegeben werden.
.SH BUGS
Manchmal funktioniert MeinTool, aber in der Regel
sollte man sich nicht darauf verlassen.
.SH AUTHOR
Steffen Wendzel <cdp@doomed-reality.org>
.SH "SEE ALSO"
.BR reboot (8)

Um aus diesem Textbatzen eine Manpage zu generieren, ruft man groff mit dem Parameter -man auf. Möchte man nicht gerade eine PostScript-Datei generiert haben, so verwendet man -Tascii, damit groff die Manpage im ASCII-Format ausgibt.

Listing 30.68 groff aufrufen

# PostScript-Datei:
$ groff -man mytool.1 > mytool.ps
# ASCII-Manpage:
$ groff -man -Tascii mytool.1 | less

Rheinwerk Computing - Zum Seitenanfang

30.12.2 Manpages installierenZur vorigen Überschrift

Um die Manpage auch im System zu installieren, haben Sie zwei Möglichkeiten:

  • Kopieren Sie die Quelldatei der Manpage (die Datei mit den Anweisungen für groff) in das entsprechende Sektionsverzeichnis des lokalen Manpage-Verzeichnisses. Die Sektionsverzeichnisse heißen man1 für Sektion 1, man2 für Sektion 2 und so weiter; sie befinden sich i.d.R. im Verzeichnis /usr/local/man/.
  • Listing 30.69 Kopieren

    $ cp mytool.1 /usr/local/man/man1/
  • Leiten Sie die ASCII-Ausgaben von groff in ein Verzeichnis einer cat-Sektion. Ein solches Verzeichnis befindet sich ebenfalls im lokalen Manpage-Verzeichnis.
  • Listing 30.70 Umleiten

    $ groff -man -Tascii mytool.1 >/usr/local/man/cat1/mytool.0
Abbildung

Abbildung 30.6 Die fertige Manpage

Beide Installationsmöglichkeiten eignen sich auch hervorragend, um die Manpage über ein install-Target eines Makefiles zu installieren.



Ihr Kommentar

Wie hat Ihnen das <openbook> gefallen? Wir freuen uns immer über Ihre freundlichen und kritischen Rückmeldungen.

>> Zum Feedback-Formular
<< zurück
 Ihre Meinung?
Wie hat Ihnen das <openbook> gefallen?
Ihre Meinung

 Buchempfehlungen
Zum Katalog: Linux Handbuch






 Linux Handbuch


Zum Katalog: Linux Server






 Linux Server


Zum Katalog: Raspberry Pi






 Raspberry Pi


Zum Katalog: Ubuntu 14.04 LTS






 Ubuntu 14.04 LTS


Zum Katalog: Roboter bauen mit Arduino






 Roboter bauen
 mit Arduino


 Shopping
Versandkostenfrei bestellen in Deutschland und Österreich
InfoInfo




Copyright © Rheinwerk Verlag GmbH 2012
Für Ihren privaten Gebrauch dürfen Sie die Online-Version natürlich ausdrucken. Ansonsten unterliegt das <openbook> denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.


Nutzungsbestimmungen | Datenschutz | Impressum

Rheinwerk Verlag GmbH, Rheinwerkallee 4, 53227 Bonn, Tel.: 0228.42150.0, Fax 0228.42150.77, service@rheinwerk-verlag.de