From b85aeda93e01e4b2e32cfcf071ee5dc7ba4d6b19 Mon Sep 17 00:00:00 2001 From: cedricbonhomme Date: Wed, 25 Jul 2012 14:05:00 +0200 Subject: [PATCH] Added code-block for bash in the Sphinx documentatioN; --- docs/index.rst | 5 +++++ docs/tutorial.rst | 18 +++++++++++++++--- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 87dc279..f97055c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,6 +40,11 @@ Moreover some methods of steganalysis are provided: - statistical steganalysis. +Turorial +======== + +More information available at the [[tutorial]] page + Indices and tables ================== diff --git a/docs/tutorial.rst b/docs/tutorial.rst index e6a71a3..e8cdc5e 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -1,9 +1,11 @@ Getting Stéganô =============== -$ hg clone https://bitbucket.org/cedricbonhomme/stegano -$ cd stegano/ -$ chmod u+x *.py # if you want to use Stéganô in command line +.. code-block:: bash + + $ hg clone https://bitbucket.org/cedricbonhomme/stegano + $ cd stegano/ + $ chmod u+x *.py # if you want to use Stéganô in command line Installation ============ @@ -32,6 +34,8 @@ Using Stéganô in command line for your scripts Display help ------------ +.. code-block:: bash + $ ./slsb.py --help Usage: slsb.py [options] @@ -55,6 +59,8 @@ Display help Hide and reveal a text message ------------------------------ +.. code-block:: bash + $ ./slsb.py --hide -i ./pictures/Lenna.png -o ./pictures/Lenna_enc.png -m HelloWorld! $ ./slsb.py --reveal -i ./pictures/Lenna_enc.png HelloWorld! @@ -62,6 +68,8 @@ Hide and reveal a text message Hide and reveal a binary file ----------------------------- +.. code-block:: bash + $ wget http://www.gnu.org/music/free-software-song.ogg $ ./slsb.py --hide -i ./pictures/Montenach.png -o ./pictures/Montenach_enc.png -f ./free-software-song.ogg $ rm free-software-song.ogg @@ -70,12 +78,16 @@ Hide and reveal a binary file Hide and reveal a message by using the description field of the image --------------------------------------------------------------------- +.. code-block:: bash + $ ./exif-header.py --hide -i ./Elisha-Cuthbert.jpg -o ./Elisha-Cuthbert_enc.jpg -f ./fileToHide.txt $ ./exif-header.py --reveal -i ./Elisha-Cuthbert_enc.jpg Steganalysis ------------ +.. code-block:: bash + $ ./steganalysis-parity.py -i ./pictures./Lenna_enc.png -o ./pictures/Lenna_enc_st.png