Redblack: Added search_up

[libucw.git] / ucw / doc / opt.txt

diff --git a/ucw/doc/opt.txt b/ucw/doc/opt.txt
index e5e5900c67f9d49121c94fd00ab8103ddce061df..610ce1ef01976b691fc108b4d95617a5dc7f1ddd 100644 (file)
--- a/ucw/doc/opt.txt
+++ b/ucw/doc/opt.txt
@@ -64,14 +64,20 @@ Most options have the following properties:
   Alternatively, the short name can refer to a <<positional,positional argument>>.
 - Long name: an arbitrary string. Set to NULL if the option has no long form.
 - Variable, where the value of the option shall be stored, together with
-  its <<conf:enum_cf_type,data type>>.
-- Flags further specifying behavior of the option (whether it is mandatory,
+  its <<conf:enum_cf_type,data type>>. The type is either one of the conventional
+  types (`int`, `uint`, etc.), or a user-defined type providing its own parser
+  function via <<conf:struct_cf_user_type,`cf_user_type`>>.
+- <<flags,Flags>> further specifying behavior of the option (whether it is mandatory,
   whether it carries a value, whether it can be set repeatedly, etc.).
-  FIXME: Reference to flags and their defaults.
 - Help text, from which the help displayed to the user is constructed.
-  FIXME: Explain tabs and newlines.
 - Extra data specific for the particular class.
 
+The help is generated in a three-column format. The first column contains the
+short names, then come the long names, and finally option descriptions.
+The help text starts in column 2 (where it can describe the option's argument);
+you can use the tab character to advance to the next column. When a newline
+character appears, the text continues on the next line in column 1.
+
 [[opt_h]]
 ucw/opt.h
 ---------