Mercurial > p > roundup > code
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 7794:1632bdbfbef6 | 7795:d7d68da9878f |
|---|---|
| 1405 | 1405 |
| 1406 (for more details see https://issues.roundup-tracker.org/issue2550789.) | 1406 (for more details see https://issues.roundup-tracker.org/issue2550789.) |
| 1407 | 1407 |
| 1408 .. index:: ! roundup-admin; usage in scripts | 1408 .. index:: ! roundup-admin; usage in scripts |
| 1409 | 1409 |
| 1410 Using Interactively | |
| 1411 ------------------- | |
| 1412 | |
| 1413 You can edit the command line using left/right arrow keys to move the | |
| 1414 cursor. Using the up/down arrow keys moves among commands. It will | |
| 1415 save your commands between roundup-admin sessions. This is supported | |
| 1416 on Unix/Linux and Mac's. On windows you should install the pyreadline3 | |
| 1417 package (see `installation documentation`_). | |
| 1418 | |
| 1419 Using the ``history_length`` pragma you can set the saved history size | |
| 1420 for just one session. | |
| 1421 | |
| 1422 You can add initialization commands to ``~/.roundup_admin_rlrc``. It | |
| 1423 will be loaded when roundup-admin starts. This is the mechanism to | |
| 1424 persistently set the number of history commands, change editing modes | |
| 1425 (Vi vs. Emacs). Note that redefining the history file will not work. | |
| 1426 | |
| 1427 If you are using GNU readline, ``set history-size 10``. If your | |
| 1428 installation uses libedit (macs), it should be possible to | |
| 1429 persistently set the history size using ``history size | |
| 1430 10``. Pyreadline3 can set history length using | |
| 1431 ``history_length(10)``. See the older documentation for example syntax: | |
| 1432 https://pythonhosted.org/pyreadline/usage.html.persistently. | |
| 1433 | |
| 1434 History is saved to the file ``.roundup_admin_history`` in your home | |
| 1435 directory (for windows usually ``\Users\<username>``. | |
| 1436 | |
| 1410 Using with the shell | 1437 Using with the shell |
| 1411 -------------------- | 1438 -------------------- |
| 1412 | 1439 |
| 1413 With version 0.6.0 or newer of roundup (which introduced support for | 1440 With version 0.6.0 or newer of roundup (which introduced support for |
| 1414 multiple designators to display and the -d, -S and -s flags): | 1441 multiple designators to display and the -d, -S and -s flags): |