Automatisch erzeugte Manpages.
Damit nicht jeder sphinx auf dem Rechner haben muss,
behalten wir bis auf weiteres die aus den .rst
erzeugten Manpoages auch im Repo.
Change-Id: Id556c0d11cf5f79659d8350952ce1c014d81ea44
diff --git a/doc/sefun/break_string b/doc/sefun/break_string
index 52d4d7b..8e3017d 100644
--- a/doc/sefun/break_string
+++ b/doc/sefun/break_string
@@ -1,90 +1,112 @@
-FUNKTION:
- string break_string(string str)
- string break_string(string str, int width)
- string break_string(string str, int width, string indent)
- string break_string(string str, int width, int space)
- string break_string(string str, int width, string indent, int flags)
- string break_string(string str, int width, int space, int flags)
-ARGUMENTE:
- str - umzubrechender String
- width - optional: maximale Zeilenlaenge (default 78)
- indent - optional: String, der vor jeder umgebrochenen Zeile erscheint
- space - optional: Anzahl der Leerzeichen vor jeder umgebrochenen Zeile
- flags - optional: hiermit laesst sich das Verhalten von break_string()
- aendern; moegliche Flags siehe Punkt 'Beschreibung'
+break_string()
+**************
-BESCHREIBUNG:
- In der ersten Form wird der String 'str' durch Einfuegen von "\n" so um-
- gebrochen, dass bei einer anschliessenden Ausgabe keine Zeile laenger
- als 'width' Zeichen ist. Eventuell schon in 'str' vorhandene "\n" werden
- dabei vorher entfernt.
- Gibt man zusaetzlich noch einen String 'indent' an, so wird dieser vor
- jede der umgebrochenen Zeilen gesetzt.
+FUNKTION
+========
- Analog wird bei der Angabe der Zahl 'space' ein String mit 'space' Leer-
- zeichen vor jede umgebrochene Zeile gesetzt.
+ string break_string(string str)
+ string break_string(string str, int width)
+ string break_string(string str, int width, string indent)
+ string break_string(string str, int width, int space)
+ string break_string(string str, int width, string indent, int flags)
+ string break_string(string str, int width, int space, int flags)
- Zusaetzlich gibt es folgende optionale Flags, die man beliebig kombinieren
- kann:
- BS_LEAVE_MY_LFS - schon im Text vorhandene "\n" werden beibehalten
- BS_SINGLE_SPACE - doppelte Leerzeichen sowie Leerzeichen nach Zeilen-
- umbruechen werden entfernt
- BS_BLOCK - der Text wird im Blocksatz formatiert
- BS_NO_PARINDENT - bei Blocksatz mit vorgegebenen Zeilenumbruechen
- (BS_BLOCK|BS_LEAVE_MY_LFS) werden Zeilen nach "\n"
- normalerweise mit einem Leerzeichen begonnen.
- Um das Einfuegen des fuehrenden Leerzeichens zu
- unterdruecken, muss BS_NO_PARINDENT angegeben werden
- BS_INDENT_ONCE - die erste Zeile des Textes wird mit vorangestelltem
- 'indent' ausgegeben; alle folgenden Zeilen bekommen
- einen Leerstring vorangestellt
- BS_PREPEND_INDENT - der Ident wird dem Text vorangestellt sofern der
- Indent + Text laenger als eine Zeile ist. Der Text
- wird um ein Leerzeichen eingerueckt, was mittels
- BS_NO_PARINDENT verhindert werden kann.
+ARGUMENTE
+=========
-RUECKGABEWERT:
- Der umgebrochene Text.
+ str - umzubrechender String
+ width - optional: maximale Zeilenlaenge (default 78)
+ indent - optional: String, der vor jeder umgebrochenen Zeile erscheint
+ space - optional: Anzahl der Leerzeichen vor jeder umgebrochenen Zeile
+ flags - optional: hiermit laesst sich das Verhalten von break_string()
+ aendern; moegliche Flags siehe Punkt 'Beschreibung'
- Laufzeit-Fehler, wenn der Indent laenger ist als die vorgegebene Breite.
-BEISPIELE:
- write(break_string("Dies ist ein laengerer Text. Nur so als Beispiel.",27));
+BESCHREIBUNG
+============
- => Dies ist ein laengerer
- Text. Nur so als Beispiel.
+ In der ersten Form wird der String 'str' durch Einfuegen von "\n" so um-
+ gebrochen, dass bei einer anschliessenden Ausgabe keine Zeile laenger
+ als 'width' Zeichen ist. Eventuell schon in 'str' vorhandene "\n" werden
+ dabei vorher entfernt.
- write(break_string("Mit indent sieht das so aus", 30, "Wargon sagt: "));
+ Gibt man zusaetzlich noch einen String 'indent' an, so wird dieser vor
+ jede der umgebrochenen Zeilen gesetzt.
- => Wargon sagt: Mit indent sieht
- Wargon sagt: das so aus
+ Analog wird bei der Angabe der Zahl 'space' ein String mit 'space' Leer-
+ zeichen vor jede umgebrochene Zeile gesetzt.
- write(break_string("Mit indent sieht das so aus", 30, "Wargon sagt: ",
- BS_INDENT_ONCE));
+ Zusaetzlich gibt es folgende optionale Flags, die man beliebig kombinieren
+ kann:
- => Wargon sagt: Mit indent sieht
- das so aus
+ BS_LEAVE_MY_LFS - schon im Text vorhandene "\n" werden beibehalten
+ BS_SINGLE_SPACE - doppelte Leerzeichen sowie Leerzeichen nach Zeilen-
+ umbruechen werden entfernt
+ BS_BLOCK - der Text wird im Blocksatz formatiert
+ BS_NO_PARINDENT - bei Blocksatz mit vorgegebenen Zeilenumbruechen
+ (BS_BLOCK|BS_LEAVE_MY_LFS) werden Zeilen nach "\n"
+ normalerweise mit einem Leerzeichen begonnen.
+ Um das Einfuegen des fuehrenden Leerzeichens zu
+ unterdruecken, muss BS_NO_PARINDENT angegeben werden
+ BS_INDENT_ONCE - die erste Zeile des Textes wird mit vorangestelltem
+ 'indent' ausgegeben; alle folgenden Zeilen bekommen
+ einen Leerstring vorangestellt
+ BS_PREPEND_INDENT - der Ident wird dem Text vorangestellt sofern der
+ Indent + Text laenger als eine Zeile ist. Der Text
+ wird um ein Leerzeichen eingerueckt, was mittels
+ BS_NO_PARINDENT verhindert werden kann.
- write(break_string("Mit Leerzeichen sieht das so aus", 30, 2));
- => Mit Leerzeichen sieht das so
- aus...
+RUECKGABEWERT
+=============
- write(break_string("Ich will es\naber vorformatiert!",60,
- "Wargon sagt: ", BS_LEAVE_MY_LFS));
+ Der umgebrochene Text.
- => Wargon sagt: Ich will es
- Wargon sagt: aber vorformatiert!
+ Laufzeit-Fehler, wenn der Indent laenger ist als die vorgegebene Breite.
- write(break_string("Ich will es\naber vorformatiert!",30,
- "Wargon sagt: ", BS_PREPEND_INDENT));
- => Wargon sagt:
- Ich will es aber
- vorformatiert!
+BEISPIELE
+=========
-SIEHE AUCH:
- senderwiederholung
+ write(break_string("Dies ist ein laengerer Text. Nur so als Beispiel.",27));
+
+ => Dies ist ein laengerer
+ Text. Nur so als Beispiel.
+
+ write(break_string("Mit indent sieht das so aus", 30, "Wargon sagt: "));
+
+ => Wargon sagt: Mit indent sieht
+ Wargon sagt: das so aus
+
+ write(break_string("Mit indent sieht das so aus", 30, "Wargon sagt: ",
+ BS_INDENT_ONCE));
+
+ => Wargon sagt: Mit indent sieht
+ das so aus
+
+ write(break_string("Mit Leerzeichen sieht das so aus", 30, 2));
+
+ => Mit Leerzeichen sieht das so
+ aus...
+
+ write(break_string("Ich will es\naber vorformatiert!",60,
+ "Wargon sagt: ", BS_LEAVE_MY_LFS));
+
+ => Wargon sagt: Ich will es
+ Wargon sagt: aber vorformatiert!
+
+ write(break_string("Ich will es\naber vorformatiert!",30,
+ "Wargon sagt: ", BS_PREPEND_INDENT));
+
+ => Wargon sagt:
+ Ich will es aber
+ vorformatiert!
+
+
+SIEHE AUCH
+==========
+
+ senderwiederholung