aboutsummaryrefslogtreecommitdiffstats
path: root/docs/command_line.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/command_line.txt')
-rw-r--r--docs/command_line.txt50
1 files changed, 34 insertions, 16 deletions
diff --git a/docs/command_line.txt b/docs/command_line.txt
index 0d7bab8..4ade8c1 100644
--- a/docs/command_line.txt
+++ b/docs/command_line.txt
@@ -6,24 +6,42 @@ included as well. While there are many other command line implementations
of Markdown, you may not have them installed, or you may prefer to use
Python-Markdown's various extensions.
+Generally, you will want to have the Markdown library fully installed on your
+system (``setup.py install`` or ``easy_install markdown``) to run the command
+line script.
+
+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:
+
+ python -m markdown.__main__ [options] [args]
+
+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:
+
Setup
-----
-Generally, you will want to have the may Markdown library fully installed on your
-system (``setup.py install`` or ``easy_install markdown``) to run the command line
-script. Upon installation, the ``markdown_py`` script will have been copied to
+Upon installation, the ``markdown_py`` script will have been copied to
your Python "Scripts" directory. Different systems require different methods to
ensure that any files in the Python "Scripts" directory are on your system
path.
* **Windows**:
- Assuming a default install of Python on Windows, your "Scripts" directory is
- most likely something like ``C:\\Python26\Scripts``. Verify the location of
- your "Scripts" directory and add it to you system path.
+ Assuming a default install of Python on Windows, your "Scripts" directory
+ is most likely something like ``C:\\Python26\Scripts``. Verify the location
+ of your "Scripts" directory and add it to you system path.
- Calling ``markdown_py`` from the command line will call the wrapper batch file
- ``markdown_py.bat`` in the "Scripts" directory created during install.
+ Calling ``markdown_py`` from the command line will call the wrapper batch
+ file ``markdown_py.bat`` in the "Scripts" directory created during install.
* __*nix__ (Linux, OSX, BSD, Unix, etc.):
@@ -42,16 +60,16 @@ path.
As an alternative, you could just ``cd`` into the directory which contains
the source distribution, and run it from there. However, remember that your
- markdown text files will not likely be in that directory, so it is much more
- convenient to have ``markdown_py`` on your 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.
+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
-----
@@ -71,7 +89,7 @@ For a complete list of options, run
Using Extensions
----------------
-For an extension to be ran from the command line it must be provided in a module
+For an extension to be run from the command line it must be provided in a module
which should be in your python path (see [[writing_extensions]] for details).
It can then be invoked by the name of that module: