[spp] [PATCH 4/4] docs: update common command reference

ogawa.yasufumi at lab.ntt.co.jp ogawa.yasufumi at lab.ntt.co.jp
Thu Oct 11 13:12:07 CEST 2018


From: Yasufumi Ogawa <ogawa.yasufumi at lab.ntt.co.jp>

Update description of common commands.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi at lab.ntt.co.jp>
---
 docs/guides/commands/common.rst | 55 ++++++++++++++++++++++++++++++-----------
 1 file changed, 40 insertions(+), 15 deletions(-)

diff --git a/docs/guides/commands/common.rst b/docs/guides/commands/common.rst
index ebd1fa1..36573f5 100644
--- a/docs/guides/commands/common.rst
+++ b/docs/guides/commands/common.rst
@@ -30,7 +30,7 @@
 
 
 Common Commands
-====================
+===============
 
 status
 ------
@@ -48,16 +48,34 @@ It also show a list of secondary IDs
     Connected secondary id: 2
 
 
+playback
+--------
+
+Restore network configuration from a recipe file which defines a set
+of SPP commands.
+You can prepare a recipe file by using ``record`` command or editing
+file by hand.
+
+It is recommended to use extension ``.rcp`` to be self-sxplanatory as
+a recipe, although you can use any of extensions such as ``.txt`` or
+``.log``.
+
+.. code-block:: console
+
+    spp > playback /path/to/my.rcp
+
+
 record
 ------
 
-Start recording user's input and create a history file for ``playback``
-commnad.
-Recording is stopped by executing ``exit`` or ``playback`` command.
+Start recording user's input and create a recipe file for loading
+from ``playback`` commnad.
+Recording recipe is stopped by executing ``exit`` or ``playback``
+command.
 
 .. code-block:: console
 
-    spp > record 2nfv_uni.config
+    spp > record /path/to/my.rcp
 
 .. note::
 
@@ -67,21 +85,28 @@ Recording is stopped by executing ``exit`` or ``playback`` command.
     next relase.
 
 
-playback
---------
+history
+-------
 
-Restore configuration from a config file.
-Content of config file is just a series of SPP commnad.
-You prepare a config file by using ``record`` command or editing a text
-file by hand.
+Show command history. Command history is recorded in a file named
+``$HOME/.spp_history``. It does not add some command which are no
+meaning for history, ``bye``, ``exit``, ``history`` and ``redo``.
 
-It is recommended to use extension ``.config`` to be self-sxplanatory
-as a config, although you can use any of extensions such as ``.txt`` or
-``.log``.
+.. code-block:: console
+
+    spp > history
+      1  ls
+      2  cat file.txt
+
+
+redo
+----
+
+Execute command of index of history.
 
 .. code-block:: console
 
-    spp> playback 2nfv_uni.config
+    spp > redo 5  # exec 5th command in the history
 
 
 pwd
-- 
2.7.4



More information about the spp mailing list