diff doc/admin_guide.txt @ 7795:d7d68da9878f

save roundup-admin history between sessions. Also load ~/.roundup_admin_rlrc (rlrc readline run commands) file to set history-size persistently, allow user to use vi mode etc.
author John Rouillard <rouilj@ieee.org>
date Sun, 10 Mar 2024 13:44:13 -0400
parents 5b41018617f2
children 8bdf0484215c
line wrap: on
line diff
--- a/doc/admin_guide.txt	Sat Mar 09 22:19:17 2024 -0500
+++ b/doc/admin_guide.txt	Sun Mar 10 13:44:13 2024 -0400
@@ -1407,6 +1407,33 @@
 
 .. index:: ! roundup-admin; usage in scripts
 
+Using Interactively
+-------------------
+
+You can edit the command line using left/right arrow keys to move the
+cursor. Using the up/down arrow keys moves among commands. It will
+save your commands between roundup-admin sessions. This is supported
+on Unix/Linux and Mac's. On windows you should install the pyreadline3
+package (see `installation documentation`_).
+
+Using the ``history_length`` pragma you can set the saved history size
+for just one session.
+
+You can add initialization commands to ``~/.roundup_admin_rlrc``. It
+will be loaded when roundup-admin starts. This is the mechanism to
+persistently set the number of history commands, change editing modes
+(Vi vs. Emacs). Note that redefining the history file will not work.
+
+If you are using GNU readline, ``set history-size 10``. If your
+installation uses libedit (macs), it should be possible to
+persistently set the history size using ``history size
+10``. Pyreadline3 can set history length using
+``history_length(10)``. See the older documentation for example syntax:
+https://pythonhosted.org/pyreadline/usage.html.persistently.
+
+History is saved to the file ``.roundup_admin_history`` in your home
+directory (for windows usually ``\Users\<username>``.
+
 Using with the shell
 --------------------
 

Roundup Issue Tracker: http://roundup-tracker.org/