mirrors/xonsh
1
0
Fork 0
mirror of https://github.com/xonsh/xonsh.git synced 2025-03-04 08:24:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

more actions

Browse source
This commit is contained in:
Anthony Scopatz 2015-08-27 13:14:39 -04:00
parent 5d68a5530c
commit 4b552d09ca
1 changed files with 51 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
docs/tutorial_hist.rst
View file

@ -81,6 +81,9 @@ action, see below.
>>> history
Also note that the history object itself can be accessed through the xonsh builtin variable
``__xonsh_history__``.
``show`` action
================
@ -115,6 +118,54 @@ only the even indices from above, you could write:
In the future, ``show`` may also be used to display outputs, return values, and time stamps.
But the default behavior will remain as shown here.
``id`` action
================
Each xonsh history has its own universally unique ``sessionid``. The ``id`` action is how you
display this identified. For instance,
.. code-block:: xonshcon
>>> history id
ace97177-f8dd-4a8d-8a91-a98ffd0b3d17
``file`` action
================
Similarly, each xonsh history has its own file associated with it. The ``file`` action is
how you display the path to this file. For example,
.. code-block:: xonshcon
>>> history file
/home/me/.local/share/xonsh/xonsh-ace97177-f8dd-4a8d-8a91-a98ffd0b3d17.json
Note that by these files are stored in ``$XONSH_DATA_DIR`` environment variable. This
is, by default, set to the ``xonsh`` dir inside of the free desktop standards
``$XDG_DATA_HOME`` environment variable. See
`this page <http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html>`_ for
more details.
``info`` action
===============
The info action combines the ``id`` and ``file`` actions as well as adds some aditional
information about the current state of the history. By default, this prints a key-value
series of lines. However, it can also return a JSON formatted string.
.. code-block:: xonshcon
>>> history info
sessionid: ace97177-f8dd-4a8d-8a91-a98ffd0b3d17
filename: /home/scopatz/.local/share/xonsh/xonsh-ace97177-f8dd-4a8d-8a91-a98ffd0b3d17.json
length: 6
buffersize: 100
bufferlength: 6
.. code-block:: xonshcon
>>> history info --json
{"sessionid": "ace97177-f8dd-4a8d-8a91-a98ffd0b3d17",
"filename": "/home/scopatz/.local/share/xonsh/xonsh-ace97177-f8dd-4a8d-8a91-a98ffd0b3d17.json",
"length": 7, "buffersize": 100, "bufferlength": 7}
Exciting Techinical Detail: Lazy JSON
=====================================
woo