PageRenderTime 12ms CodeModel.GetById 2ms app.highlight 4ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/German/manpage-de.man

http://txt2tags.googlecode.com/
Unknown | 477 lines | 344 code | 133 blank | 0 comment | 0 complexity | d56e56f83b92b9aacd9ab5a187fa531b MD5 | raw file
  1.TH "TXT2TAGS" 1 "Aug, 2010" ""
  2
  3
  4.SH NAME
  5
  6.P
  7txt2tags \- Textformatierungs\- und \-konvertierungswerkzeug
  8
  9.SH SYNOPSIS
 10
 11.P
 12\fBtxt2tags\fR [\fIOptionen\fR] [\fIDATEI\fR...]
 13
 14.SH BESCHREIBUNG
 15
 16.P
 17\fBtxt2tags\fR liest einen Text mit minimalem Markup und konvertiert ihn zu:
 18\fIASCII Art\fR,
 19\fIAsciiDoc\fR,
 20\fICreole\fR,
 21\fIDocBook\fR,
 22\fIDokuWiki\fR,
 23\fIGoogle Code Wiki\fR,
 24\fIHTML\fR,
 25\fILaTeX\fR,
 26\fILout\fR,
 27\fIMagicPoint\fR,
 28\fIMan page\fR,
 29\fIMoinMoin\fR,
 30\fIPageMaker\fR,
 31\fIPlain Text\fR,
 32\fIPmWiki\fR,
 33\fISGML\fR,
 34\fIWikipedia\fR und
 35\fIXHTML\fR.
 36
 37.P
 38\fBtxt2tags\fR liest eine Textdatei mit minimalem Markup und wandelt ihn um in:
 39ASCII\-Art, AsciiDoc, Creole, DocBook, DokuWiki, Google Code Wiki,
 40HTML, LaTeX, Lout, MagicPoint, Manpage, MoinMoin, PageMaker,
 41Plain Text, PmWiki, SGML, Wikipedia und XHTML.
 42
 43.P
 44Diese Manpage wurde von txt2tags aus einer einfachen Textdatei erstellt.
 45Der gleiche Textdatei wird auch für die Online\-Version dieses Handbuchs in HTML umgewandelt.
 46Eine Quelle, MULTI\-Ziele \- http://txt2tags.org
 47
 48.P
 49EIN Quellformat, VIELE Zielformate \- http://txt2tags.org
 50
 51.SH MARKUP
 52
 53.nf
 54Headers           Die ersten 3 Zeilen der Quelldatei
 55Titel             = Wörter =
 56Nummerierter Titel + Wörter +
 57Kommentar         % Kommentare
 58Trennungslinie    -----------------------...
 59Dicke Linie       =======================...
 60Bild              [Dateiname.jpg]
 61Link              [Marke url]
 62
 63Fett              **Wörter**
 64Italic            //Wörter//
 65Understrichen     __Wörter__
 66Durchgestrichen   --Wörter--
 67Monospaced        ``Wörter``
 68Raw               ""Wörter""
 69Tagged            ''Wörter''
 70
 71Absatz            Wörter
 72Zitat             <TAB>Wörter
 73Liste             - Wörter
 74Numerierte Liste  + Wörter
 75Definitionsliste  : Wörter
 76Tabelle           | Zelle 1 | Zelle 2 | Zelle 3 ...
 77
 78Verbatim-Zeile    ``` Wörter
 79Raw-Zeile         """ Wörter
 80Tagged-Zeile      ''' Wörter
 81
 82Verbatim-Block    ```
 83                  Zeilen
 84                  ```
 85Raw-Block         """
 86                  Zeilen
 87                  """
 88Tagged-Block      '''
 89                  Zeilen
 90                  '''
 91.fi
 92
 93
 94.SH OPTIONEN
 95
 96.TP
 97    \fB\-\-art\-chars\fR=\fIMUSTER\fR
 98Definiert \fIMUSTER\fR als das Muster von Zeichen, die ASCII\-Kunst darstellen, in der folgenden Reihenfolge: corner, border, side, bar1, bar2, level2, level3, level4, level5. Der Standardwert für das Zeichenmuster ist +\-|\-==\-^". Diese Option wird nur bei ASCII\-Kunst als Zielformat benutzt.
 99
100.TP
101\fB\-C\fR, \fB\-\-config\-file\fR=\fIDATEI\fR
102Liest die Konfiguration aus einer externen \fIDATEI\fR. Die Konfiguration muß im Format \fI%!keyword:value\fR stehen. Siehe die Erläuterungen im Abschnitt EINSTELLUNGEN .
103
104.TP
105    \fB\-\-css\-sugar\fR
106Verbessert den erzeugten HTML/XHTML\-Code, wenn CSS\-Dateien verwendet werden. Tag\-Attribute werden entfernt, Darstellungs\-Tags werden vermieden, Überschriften bestehen aus H1, H2 und H3 Tags, neue DIVs werden erzeugt: \fI#header\fR, \fI#body\fR, \fI.toc\fR.
107
108.TP
109    \fB\-\-css\-inside\fR
110Fügt den Inhalt einer CSS\-Datei innerhalb der HTML/XHTML\-Kopfzeilen ein. Verwende`\-\-style``, um eine CSS\-Datei anzugeben, die gelesen werden soll.
111
112.TP
113    \fB\-\-dump\-config\fR
114Druckt die gefundene Konfiguration und beendet.
115
116.TP
117    \fB\-\-dump\-source\fR
118Druckt das Quelldokument erweitert um die Einfügungen (%!include).
119
120.TP
121    \fB\-\-encoding\fR=\fICODE\fR
122Informiert über den Zeichensatz (die Dateicodierung), der vom Quelldokument verwendet wird. Beispiele sind UTF\-8 und iso\-8859\-1. Die Codierung wird nicht während der Konvertierung geändert, so dass das Ausgabedokument die gleiche Codierung wie die Quellen erhält.
123
124.TP
125    \fB\-\-gui\fR
126Ruft die grafische Tk\-Benutzerschnittstelle auf.
127
128.TP
129\fB\-h\fR, \fB\-\-help\fR
130Druckt den Hilfetext und beendet.
131
132.TP
133\fB\-H\fR, \fB\-\-no\-headers\fR
134Unterdrückt Kopf\- und Fußzeilen in der Ausgabe. Nur der Inhalt (Body) wird gezeigt.
135
136.TP
137    \fB\-\-headers\fR
138Zeigt Kopf\- und Fußzeilen in der Ausgabe. Standard ist AN.
139
140.TP
141    \fB\-\-height\fR=\fINUM\fR
142Setzt die Höhe der Ausgabe zu \fINUM\fR Zeilen. Diese Option wird nur benutzt bei ASCII\-Kunst als Zielformat, wenn auch \-\-slides verwendet wird.
143
144.TP
145\fB\-i\fR, \fB\-\-infile\fR=\fIDATEI\fR
146Setzt \fIDATEI\fR als Eingabedateiname, das Quelldokument. Verwende '\-', um die Quellen von STDIN zu lesen.
147
148.TP
149    \fB\-\-mask\-email\fR
150Versteckt E\-Mails vor Spamrobotern. Entfernt @ und Punkte. Die Adresse foo@bar.com wird zu <foo (a) bar com>.
151
152.TP
153\fB\-n\fR, \fB\-\-enum\-title\fR
154Verwendet die automatische Nummerierung für Titelzeilen. Ihnen wird 1, 1.1, 1.1.1, ... vorangestellt.
155
156.TP
157    \fB\-\-no\-dump\-config\fR
158Beendet die \-\-dump\-config Aktion.
159
160.TP
161    \fB\-\-no\-dump\-source\fR
162Beendet die \-\-dump\-source Aktion.
163
164.TP
165    \fB\-\-no\-encoding\fR
166Löscht die Codierungseinstellung.
167
168.TP
169    \fB\-\-no\-enum\-title\fR
170Unterdrückt die automatische Nummerierung für Titelzeilen.
171
172.TP
173    \fB\-\-no\-infile\fR
174Löscht alle vorigen infile\-Deklarationen.
175
176.TP
177    \fB\-\-no\-targets\fR
178Beendet die \-\-targets Aktion.
179
180.TP
181    \fB\-\-no\-mask\-email\fR
182Unterdrückt die E\-Mailmaskierung.
183
184.TP
185    \fB\-\-no\-outfile\fR
186Löscht die vorige outfile\-Deklaration.
187
188.TP
189    \fB\-\-no\-quiet\fR
190Zeigt Meldungen, unterdrückt die \-\-quiet Option.
191
192.TP
193    \fB\-\-no\-rc\fR
194Liest nicht die Benutzerkonfigurationsdatei ~/.txt2tagsrc.
195
196.TP
197    \fB\-\-no\-slides\fR
198Schaltet das slides\-Feature aus.
199
200.TP
201    \fB\-\-no\-style\fR
202Löscht alle Stileinstellungen.
203
204.TP
205    \fB\-\-no\-toc\fR
206Entfernt das Inhaltsverzeichnis von der Ausgabe.
207
208.TP
209    \fB\-\-no\-toc\-only\fR
210Schaltet die \-\-toc\-only Aktion aus.
211
212.TP
213\fB\-o\fR, \fB\-\-outfile\fR=\fIDATEI\fR
214Setzt \fIDATEI\fR als Ausgabedateiname. Benutzt '\-', um Ergebnisse nach STDOUT zu schicken.
215
216.TP
217\fB\-q\fR, \fB\-\-quiet\fR
218Stiller Modus. Unterdrückt alle Ausgaben, außer Fehler.
219
220.TP
221    \fB\-\-rc\fR
222Liest die Benutzerkonfigurationsdatei ~/.txt2tagsrc. Standard ist AN.
223
224.TP
225    \fB\-\-slides\fR
226Formatiert die Ausgabe als Präsentation. Diese Option wird nur benutzt bei ASCII\-Kunst als Zielformat.
227
228.TP
229    \fB\-\-style\fR=\fIDATEI\fR
230Verwendet \fIDATEI\fR als Stildatei des Dokuments. Wird benutzt, um CSS\-Dateien für HTML/XHTML\-Dokumente zu definieren und Pakete für LaTeX. Diese Option kann mehrmals verwendet werden, um mehrere Dateien einzufügen.
231
232.TP
233\fB\-t\fR, \fB\-\-target\fR=\fITYPE\fR
234Setzt das Format des Ausgabedokuments zu \fITYPE\fR. Einige populäre Typen sind: \fIhtml\fR, \fIxhtml\fR, \fItex\fR, \fIman\fR, \fItxt\fR. Benutze die \-\-targets Option, um alle verfügbaren Formate zu sehen.
235
236.TP
237    \fB\-\-targets\fR
238Druckt eine Liste aller verfügbaren Zielformate und beendet.
239
240.TP
241    \fB\-\-toc\fR
242Fügt automatisch ein Inhaltsverzeichnis (TOC) in die Ausgabe zwischen Header und Body ein. Die  Position kann mit dem %%TOC Makro festgelegt werden.
243
244.TP
245    \fB\-\-toc\-level\fR=\fINUM\fR
246Setzt die maximale TOC\-Tiefe zu \fINUM\fR. Alle Titel tiefer als \fINUM\fR werden nicht ins Inhaltsverzeichnis eingefügt.
247
248.TP
249    \fB\-\-toc\-only\fR
250Druckt nur das Inhaltsverzeichnis und beendet.
251
252.TP
253\fB\-v\fR, \fB\-\-verbose\fR
254Druckt informative Nachrichten während der Konvertierung. Diese Option kann mehrmals benutzt werden, um die Anzahl der angezeigten Nachrichten zu erhöhen.
255
256.TP
257\fB\-V\fR, \fB\-\-version\fR
258Druckt die Programmversion und beendet.
259
260.TP
261    \fB\-\-width\fR=\fINUM\fR
262Setzt die Ausgabebreite auf \fINUM\fR Spalten. Diese Option wird nur bei ASCII\-Kunst als Zielformat verwendet.
263
264.SH QUELLDATEIEN
265
266.P
267Die Quelldateien werden normalerweise durch die \fI.t2t\fR Erweiterung (wie in myfile.t2t) ausgewiesen. In den Quelldateien können drei Bereiche vorkommen :
268
269.TP
270\fBHeader\fR (optional)
271Die ersten drei Zeilen der Datei. Lasse die erste Zeile leer, wenn keine Kopfzeilen gebraucht werden. Wird verwendet für Dokumenttitel, Autor, Version und Datumsinformation.
272
273.TP
274\fBSettings\fR (optional)
275Beginnt gleich nach dem Header (vierte oder zweite Zeile) und endet, wo der Body beginnt.
276Wird benutzt für Einstellungen im %!keyword:value Format.
277
278.TP
279\fBBody\fR
280Beginnt an der ersten gültigen Textzeile (nicht Kommentar oder Einstellung) nach dem Headerbereich und geht bis zum Ende des Dokuments. Wird für den Dokumentinhalt benutzt.
281
282.SH EINSTELLUNGEN
283
284.P
285Mit den Einstellungen kann \fBtxt2tags\fR angepasst werden, ähnlich den Otionen. Sie können im Quelldokument im Bereich Einstellungen benutzt werden, ~/.txt2tagsrc file, die externe Datei wird mit \-\-config\-file aufgerufen.
286
287.TP
288\fB%!target\fR
289Setzt das Ausgabeformat, wie bei \-\-target. Beispiel:
290.nf
291%!target: html
292.fi
293
294
295
296.TP
297\fB%!options(target)\fR
298Setzt die Standardoptionen für jedes Ziel. Du mußt die Optionen Kommandozeilen benutzen. Beispiel:
299.nf
300%!options(html): --toc --toc-level 3 --css-sugar
301.fi
302
303
304
305.TP
306\fB%!includeconf\fR
307Füge die Konfigurationen aus einer externen Datei in die aktuelle ein, wie bei \-\-config\-file. Beispiel:
308.nf
309%!includeconf: myconfig.t2t
310.fi
311
312
313
314.TP
315\fB%!style\fR
316Setzt eine Stildatei für das document, wie bei \-\-style. Kann mehrmals benutzt werden.  Beispiel:
317.nf
318%!style: colors.css
319.fi
320
321
322
323.TP
324\fB%!encoding\fR
325Setzt den Zeichensatz, der vom Dokument verwendet wird, wie bei \-\-encoding. Beispiel:
326.nf
327%!encoding: UTF-8
328.fi
329
330
331
332.TP
333\fB%!preproc\fR
334Wendet ein Suchen/Ersetzen Filter an, das verwendet wird um den Body vom Quelldokument zu ändern, VOR jedem Parsen durch txt2tags. Die Suche verwendet reguläre Ausdrücke von Python. Beispiel:
335.nf
336%!preproc:  "JJS"  "John J. Smith"
337.fi
338
339
340
341.TP
342\fB%!postproc\fR
343Wendet ein Suchen/Ersetzen Filter an, das verwendet wird um das erzeugte Dokument zu ändern, NACH allem Verarbeiten durch txt2tags. Die Suche verwendet reguläre Ausdrücke von Python. Beispiel:
344.nf
345%!postproc(html):  "<B>"  "<STRONG>"
346.fi
347
348
349
350.P
351Wenn das gleiche Schlüsselwort mehr als einmal vorkommt, wird das letzte gefundene benutzt (außer bei: Optionen, preproc und postproc, welche kumulativ arbeiten). Ungültige Schlüsselwörter werden ignoriert. Die Reihenfolge ist: ~/.txt2tagsrc, Konfigurationsbereich des Quelldokuments, \-\-config\-file Option.
352
353.SH COMMANDS
354
355.P
356Kommandos führen Aufgaben während der Konvertierung aus. Sie müssen in den Body des Quelldokuments geschrieben werden.
357
358.TP
359\fB%!csv: Datei.csv\fR
360Fügt eine externe CSV\-Datei als Tabelle ein.
361
362.TP
363\fB%!include: Datei.t2t\fR
364Fügt eine txt2tags\-Datei ein.
365
366.TP
367\fB%!include: ``Datei.txt``\fR
368Fügt eine Textdatei (verbatim) in das Dokument ein.
369
370.TP
371\fB%!include: \&''Datei.html''\fR
372Fügt eine bereits getaggte Datei in das Dokument ein.
373
374.SH MAKROS
375
376.P
377Makros sind handliche Abkürzungen und erlauben es dynamisch Inhalt ins Dokument einzufügen. Sie müssen in den Body des Quelldokuments gestellt werden. Mit Ausnahme von %%toc können alle Makros mit speziellen Direktiven, wie %Y and %f angepaßt werden. Für Details siehe das txt2tags Benutzerhandbuch.
378
379.TP
380\fB%%date\fR
381Fügt das aktuelle Datum ein. Das Standardformat ist %%date(%Y%m%d), was YYYYMMDD ergibt.
382
383.TP
384\fB%%infile\fR
385Fügt den Pfad der Quelldatei ein. Das Standardformat ist %%infile(%f). Nützlich für links in Fußzeilen wie [See source %%infile].
386
387.TP
388\fB%%mtime\fR
389Füge die Änderungszeit der Quelldatei ein. Das Standardformat ist %%date(%Y%m%d), welche YYYYMMDD ergibt.
390
391.TP
392\fB%%outfile\fR
393Fügt den Pfad der Ausgabedatei ein. Das Standardformat ist %%outfile(%f). Nützlich für self mentioning wie "Dieses ist die manpage\-de.man Datei".
394
395.TP
396\fB%%toc\fR
397Bestimmt wo das Inhaltsverzeichnis gesetzt wird. Kann ebenso mehrmals benutzt werden. Dafür muß ebenfalls die \-\-toc Option benutzt werden.
398
399.SH BEISPIELE
400
401.TP
402txt2tags \-t html Datei.t2t
403
404Konvertiert nach HTML, speichert in file.html.
405
406.TP
407txt2tags \-t html \-o \- Datei.t2t
408
409Konvertiert nach HTML, sendet Ergebnisse nach STDOUT.
410
411.TP
412txt2tags \-t html \-\-toc Datei.t2t
413
414Konvertiert nach HTML, fügt automatisch ein Inhaltsverzeichnis ein.
415
416.TP
417txt2tags \-t html \-\-toc \-\-toc\-level 2 \-n Datei.t2t
418
419Konvertiert nach HTML, mit einem Inhaltsverzeichnis mit zwei Ebenen und nummerierten Titeln.
420
421.TP
422txt2tags \-\-toc\-only Datei.t2t
423
424Zeigt nur das Inhaltsverzeichnis, ohne Konvertierung.
425
426.TP
427txt2tags \-t html \-\-css\-sugar \-\-style base.css \-\-style ui.css Datei.t2t
428
429Konvertiert nach HTML, bereitet den sich ergebenden Code vor für CSS, und fügt Aufrufe von zwei externen CSS Dateien ein.
430
431.TP
432txt2tags \-t art \-\-slides \-\-width 80 \-\-height 25 \-o \- Datei.t2t | more
433
434Erzeugt Präsentationsfolien in ASCII\-Kunst, um auf einem 80x25 Bildschirm gezeigt zu werden.
435
436.TP
437(echo ; echo "**bold**") | txt2tags \-t html \-H \-
438
439Handlicher Einzeiler für schnelle Tests mit STDIN.
440
441.TP
442txt2tags \-t html \-o \- Datei.t2t | tidy > Datei.html
443
444Sendet Ergebnisse an STDOUT, dann verfeinere den Code mit einem externen Programm vor dem Speichern der Ausgabedatei.
445
446.SH DATEIEN
447
448.TP
449~/.txt2tagsrc
450Konfigurationsdatei vom Standardbenutzer.
451
452.SH UMGEBUNG
453
454.TP
455T2TCONFIG
456Wenn nicht Null, wird der volle Pfadnamen für die Standardkonfigurationsdatei gesetzt.
457
458.SH AUTOR
459
460.P
461Aurelio Jargas <verde@aurelio.net>
462
463.P
464Manpage ins Deutsche übersetzt von Michael Malien, michael.malien@gmx.de.
465
466.SH BUGS
467
468.P
469http://bugs.txt2tags.org
470
471.SH COPYRIGHT
472
473.P
474Copyright (C) 2001\-2012 Aurelio Jargas, GNU GPL v2
475
476.\" man code generated by txt2tags 2.6.641 (http://txt2tags.org)
477.\" cmdline: txt2tags doc/German/manpage-de.t2t