aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cli.txt
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2013-02-19 16:33:36 -0500
committerWaylan Limberg <waylan@gmail.com>2013-02-19 16:33:36 -0500
commit8aa2fc7b5138fd97ded7dd1e70103532a9fd6583 (patch)
treea85aec909892c3e9ca08d23369f0e743e3beb177 /docs/cli.txt
parent3b732805676969fdf61ac3214c42ab94e96da0ea (diff)
downloadmarkdown-8aa2fc7b5138fd97ded7dd1e70103532a9fd6583.tar.gz
markdown-8aa2fc7b5138fd97ded7dd1e70103532a9fd6583.tar.bz2
markdown-8aa2fc7b5138fd97ded7dd1e70103532a9fd6583.zip
Various changes to docs for updated changes, clarity, and to fix typos.
Diffstat (limited to 'docs/cli.txt')
-rw-r--r--docs/cli.txt23
1 files changed, 12 insertions, 11 deletions
diff --git a/docs/cli.txt b/docs/cli.txt
index 9babc50..719bc0c 100644
--- a/docs/cli.txt
+++ b/docs/cli.txt
@@ -21,8 +21,8 @@ Assuming the `python` executable is on your system path, just run the following:
python -m markdown [options] [args]
-That will run the module as a script. Note that on older Python versions (2.5
-and 2.6), you may need to specify the appropriate module:
+That will run the module as a script. Note that on older Python versions (2.6),
+you may need to specify the appropriate module:
python -m markdown.__main__ [options] [args]
@@ -30,8 +30,8 @@ Use the `--help` option for available options:
python -m markdown --help
-If you are using Python 2.4 or you don't want to have to call the python
-executable directly, follow the instructions below:
+If you don't want to call the python executable directly, follow the
+instructions below:
Setup
-----
@@ -70,13 +70,14 @@ path.
markdown text files will not likely be in that directory, so it is much
more convenient to have ``markdown_py`` on your path.
-__Note:__ Python-Markdown uses "markdown_py" as a script name because
-the Perl implementation has already taken the more obvious name "markdown".
-Additionally, the default Python configuration on some systems would cause a
-script named "markdown.py" to fail by importing itself rather than the markdown
-library. Therefore, the script has been named "markdown_py" as a compromise. If
-you prefer a different name for the script on your system, it is suggested that
-you create a symbolic link to `markdown_py` with your preferred name.
+!!!Note
+ Python-Markdown uses "markdown_py" as a script name because
+ the Perl implementation has already taken the more obvious name "markdown".
+ Additionally, the default Python configuration on some systems would cause a
+ script named "markdown.py" to fail by importing itself rather than the markdown
+ library. Therefore, the script has been named "markdown_py" as a compromise. If
+ you prefer a different name for the script on your system, it is suggested that
+ you create a symbolic link to `markdown_py` with your preferred name.
Usage
-----