Manpages als reStructuredText erstellt
Unsere Manpages wurden mit einem LPC-Tool in
reStructuredText konvertiert und liegen jetzt
in diesem Verzeichnis als Quelldaten.
Aus diesen reStructuredText sollen dann per
Script die ASCII-Manpages und per Sphinx HTML u.a.
erzeugt werden.
Change-Id: I75d659a7b3f9863aecb11dbeb0037e6cae227c36
diff --git a/doc/sphinx/sefun/save_object.rst b/doc/sphinx/sefun/save_object.rst
new file mode 100644
index 0000000..3dcc523
--- /dev/null
+++ b/doc/sphinx/sefun/save_object.rst
@@ -0,0 +1,34 @@
+save_object()
+=============
+
+SYNOPSIS
+--------
+::
+
+ mixed save_object(string name);
+
+BESCHREIBUNG
+------------
+::
+
+ Diese Simul-Efun unterscheidet sich in einigen Details von der
+ Driver-Efun save_object() (s. auch dort! Wichtig!).
+ 1. diese sefun speichert auch die mit F_SAVE markierten Properties
+ eines Objektes ab (was die efun des Driver nicht tut!).
+ 2. Sofern ein Pfad angegeben wird und dieser NICHT mit /data/ beginnt,
+ wird /data/ vorangestellt, d.h. das Savefile wird immer unter /data/
+ erstellt.
+ 3. das Format, in dem gespeichert wird, kann bei der sefun nicht
+ ausgewaehlt werden (ist aber auch nicht noetig!), sondern ein
+ mudlib-weiter Standard wird benutzt.
+ 4. will man nicht in einem File speichern, sondern das, was im File
+ stehen wurde, als String zurueckhaben, muss man 0 als 'name'
+ uebergeben.
+
+SIEHE AUCH
+----------
+::
+
+ save_object(E), restore_object(E), save_value(E)
+29.01.2017, Zesstra
+