From 65f8bd2b91539f72ea0805a76183ad2c56b94eeb Mon Sep 17 00:00:00 2001 From: Berker Peksag Date: Sat, 25 Jan 2014 21:32:56 +0200 Subject: [PATCH] Document hyc command line options. --- docs/language/cli.rst | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/language/cli.rst b/docs/language/cli.rst index 317e233..5b9dc73 100644 --- a/docs/language/cli.rst +++ b/docs/language/cli.rst @@ -2,8 +2,11 @@ Command Line Interface ====================== +hy +-- + Command line options --------------------- +^^^^^^^^^^^^^^^^^^^^ .. cmdoption:: -c @@ -41,3 +44,30 @@ Command line options .. cmdoption:: -v Print the Hy version number and exit. + + +hyc +--- + +Command line options +^^^^^^^^^^^^^^^^^^^^ + +.. cmdoption:: file[, fileN] + + Compile Hy code to Python bytecode. For example, save the + following code as ``hyname.hy``: + + .. code-block:: clojure + + (defn hy-hy [name] + (print (+ "Hy " name "!"))) + + (hy-hy "Afroman") + + Then run: + + .. code-block:: bash + + $ hyc hyname.hy + $ python hyname.pyc + Hy Afroman!