diff options
Diffstat (limited to 'docs/cli.txt')
| -rw-r--r-- | docs/cli.txt | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/cli.txt b/docs/cli.txt index 5098771..c2b37e4 100644 --- a/docs/cli.txt +++ b/docs/cli.txt @@ -23,18 +23,18 @@ following format: $ python -m markdown [options] [args] -That will run the module as a script with the options and args provided. +That will run the module as a script with the options and arguments provided. At its most basic usage, one would simply pass in a file name as the only argument: $ python -m markdown input_file.txt -Piping input and output (on STDIN and STDOUT) is fully supported as well. +Piping input and output (on `STDIN` and `STDOUT`) is fully supported as well. For example: $ echo "Some **Markdown** text." | python -m markdown > output.html -Use the `--help` option for a list all available options and args: +Use the `--help` option for a list all available options and arguments: $ python -m markdown --help @@ -44,7 +44,7 @@ follow the instructions below to use a wrapper script: Setup ----- -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. @@ -52,11 +52,11 @@ path. * **Windows**: Assuming a default install of Python on Windows, your "Scripts" directory - is most likely something like ``C:\\Python26\Scripts``. Verify the location + 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.): @@ -64,33 +64,33 @@ path. of them here, we'll provide a few helpful pointers: * Some systems will automatically install the script on your path. Try it - and see if it works. Just run ``markdown_py`` from the command line. + and see if it works. Just run `markdown_py` from the command line. * Other systems may maintain a separate "Scripts" ("bin") directory which you need to add to your path. Find it (check with your distribution) and either add it to your path or make a symbolic link to it from your path. - * If you are sure ``markdown_py`` is on your path, but it still isn't being + * If you are sure `markdown_py` is on your path, but it still is not being found, check the permissions of the file and make sure it is executable. - As an alternative, you could just ``cd`` into the directory which contains + 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. + more convenient to have `markdown_py` on your path. !!!Note - Python-Markdown uses "markdown_py" as a script name because + 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 + 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 ----- -To use ``markdown_py`` from the command line, run it as +To use `markdown_py` from the command line, run it as $ markdown_py input_file.txt @@ -133,15 +133,15 @@ above example might look like this: UNIQUE_IDS: True Note that while the `--extension_configs` option does specify the "markdown.extensions.footnotes" -extension, you still need to load the extension with the `-x` option, or the configs for that +extension, you still need to load the extension with the `-x` option, or the configuration for that extension will be ignored. -The `--extension_configs` option will only support YAML config files if [PyYaml] is +The `--extension_configs` option will only support YAML configuration files if [PyYAML] is installed on your system. JSON should work with no additional dependencies. The format -of your config file is automatically detected. +of your configuration file is automatically detected. !!!warning - The previously documented method of appending the extension configs as a string to the + The previously documented method of appending the extension configuration options as a string to the extension name will be deprecated in Python-Markdown version 2.6. The `--extension_configs` option should be used instead. See the [2.5 release notes] for more information. |