Document command line options.

This commit is contained in:
Berker Peksag 2013-12-05 15:00:13 +02:00 committed by Abhishek L
parent f9a1995be8
commit 2c76d8ec90
2 changed files with 36 additions and 0 deletions

35
docs/language/cli.rst Normal file
View File

@ -0,0 +1,35 @@
======================
Command Line Interface
======================
Command line options
--------------------
.. cmdoption:: -c <command>
Execute the Hy code in *command*.
.. code-block:: bash
$ hy -c "(print (+ 2 2))"
4
.. cmdoption:: -i <command>
Execute the Hy code in *command*, then stay in REPL.
.. cmdoption:: --spy
Print equivalent Hy code before executing. For example::
=> (defn salutationsnm [name] (print (+ "Hy " name "!")))
def salutationsnm(name):
return print(((u'Hy ' + name) + u'!'))
=> (salutationsnm "YourName")
salutationsnm(u'YourName')
Hy YourName!
=>
.. cmdoption:: -v
Print the Hy version number and exit.

View File

@ -7,6 +7,7 @@ Contents:
.. toctree::
:maxdepth: 3
cli
api
core
internals