Display progress bar

[sqlconvert.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index e9c3631699c7b36bb1f52cdb9744167139f1b479..242918a82b9662afe66a49842caaa5a6d2d06e45 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -20,17 +20,38 @@ The program is in its initial phase and currently cannot do much.
 Command line
 ------------
 
-mysql-to-sql.py
-~~~~~~~~~~~~~~~
+mysql2sql
+~~~~~~~~~
 
 Usage::
 
-    mysql-to-sql.py [-i infile] [-o outfile]
+    mysql2sql [-e encoding] [-E output_encoding] [infile] [[-o] outfile]
 
 Options::
 
-    -i, --infile infile    Input file, stdin if absent
-    -o, --outfile outfile  Output file, stdout if absent
+    -e ENCODING, --encoding ENCODING
+                           input/output encoding, default is utf-8
+    -E OUTPUT_ENCODING, --output-encoding OUTPUT_ENCODING
+                           separate output encoding, default is the same as
+                           `-e` except for console; for console output charset
+                           from the current locale is used
+    -P, --no-pbar          Inhibit progress bar
+    infile                 Input file, stdin if absent or '-'
+    -o, --outfile outfile  Output file, stdout if absent or '-'
+
+If stderr is connected to the console the program displays a text mode progress
+bar. Option `-P/--no-pbar` inhibits it.
+
+Option `-o` is useful when infile is absent (input is redirected), for
+example::
+
+    mysql2sql -o outfile.sql < infile.sql
+    cat infile.sql | mysql2sql -o outfile.sql
+
+But of course it simply can be::
+
+    mysql2sql - outfile.sql < infile.sql
+    cat infile.sql | mysql2sql - outfile.sql
 
 
 Indices and tables