Rename mysql2sql -> sqlconvert

[sqlconvert.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 242918a82b9662afe66a49842caaa5a6d2d06e45..46e6c4592324f04f88b8327e118745759792b220 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,57 +1,26 @@
-.. mysql2sql documentation master file, created by
+.. sqlconvert documentation master file, created by

    sphinx-quickstart on Fri Jul 22 19:32:24 2016.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
    sphinx-quickstart on Fri Jul 22 19:32:24 2016.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 

-Welcome to mysql2sql's documentation!
+Welcome to sqlconvert's documentation!

 =====================================
 
 =====================================
 

-This is mysql2sql, a mysql to sql converter. It is primary intended to
-convert mysqldump (especially with extended INSERT syntax) to standard
-SQL to load at least to PostgreSQL or SQLite.
-
-It uses `sqlparse <https://github.com/andialbrecht/sqlparse>`_ to parse
-SQL.
+This is sqlconvert, a library to implenet SQL converters. It uses `sqlparse
+<https://github.com/andialbrecht/sqlparse>`_ to parse SQL.

 
 The program is in its initial phase and currently cannot do much.
 
 
 The program is in its initial phase and currently cannot do much.
 

-.. highlight:: none
-
-Command line
-------------
-
-mysql2sql
-~~~~~~~~~
-
-Usage::
-
-    mysql2sql [-e encoding] [-E output_encoding] [infile] [[-o] outfile]
-
-Options::
-
-    -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::
+The first goal is to implemet `mysq2sql <mysq2sql.html>`_, a script intended
+primarily to convert mysqldump (especially with extended INSERT syntax) to
+standard SQL to load at least to PostgreSQL or SQLite.

 
 

-    mysql2sql -o outfile.sql < infile.sql
-    cat infile.sql | mysql2sql -o outfile.sql
+Contents:

 
 

-But of course it simply can be::
+.. toctree::
+   :maxdepth: 2

 
 

-    mysql2sql - outfile.sql < infile.sql
-    cat infile.sql | mysql2sql - outfile.sql
+   mysq2sql

 
 
 Indices and tables
 
 
 Indices and tables