]> mj.ucw.cz Git - libucw.git/commitdiff
tableprinter: update of documentation
authorRobert Kessl <kesslr@centrum.cz>
Fri, 20 Jun 2014 12:03:26 +0000 (14:03 +0200)
committerRobert Kessl <kesslr@centrum.cz>
Fri, 20 Jun 2014 12:03:26 +0000 (14:03 +0200)
ucw/table.h

index e1a0b50417ea512c2b13564e469ebbe7a93971cd..1e771f86b1be8cba42b3a36b60a328418ea1199d 100644 (file)
@@ -165,6 +165,15 @@ enum column_type {
  *
  * Features:
  * - user supplied callback functions can be used for modifying the output format.
+ *
+ * Command-line options (provided through table_set_option and friends):
+ *   key      value                       explanation
+ *  header    [0|1]                       0=do not print the header
+ *  cols      <col-name>[,<col-name>]*    list of column names delimited by comma ','
+ *            '*'                         or star '*' meaning all columns
+ *   fmt      [human|machine|blockline]   output format
+ * col-delim  <string>                    string used as a column delimiter
+ *
  ***/
 
 struct table;