;doc:repl: updates

Corrected one small mistake, and changed a few other things for clarity.
This commit is contained in:
Pranesh Prakash 2025-03-08 02:17:27 +05:30 committed by Simon Michael
parent 5109a9682f
commit fc2aabaab3

View File

@ -15,8 +15,8 @@ commands will run more quickly than if you ran them individually at the
command line. command line.
Also like run, the input file(s) specified for the repl command will be Also like run, the input file(s) specified for the repl command will be
the default input for all interactive commands, you can override this the default input for all interactive commands. You can override this
temporarily by specifying an -f option in particular commands, and temporarily by specifying an -f option in particular commands. But
commands will not see any changes made to input files (eg by add) until commands will not see any changes made to input files (eg by add) until
you exit and restart the REPL. you exit and restart the REPL.
@ -29,10 +29,11 @@ The command syntax is the same as with run:
- type exit or quit or control-D to exit the REPL. - type exit or quit or control-D to exit the REPL.
While it is running, the REPL remembers your command history, and you While it is running, the REPL remembers your command history, and you
can navigate in the usual ways: - Keypad or Emacs navigation keys to can navigate in the usual ways:
edit the current command line - UP/DOWN or control-P/control-N to step
back/forward through history - control-R to search for a past command, - Keypad or Emacs navigation keys to edit the current command line
etc. - UP/DOWN or control-P/control-N to step back/forward through history
- control-R to search for a past command, etc.
The commands and help commands, and the command help flags (CMD --tldr, The commands and help commands, and the command help flags (CMD --tldr,
CMD -h/--help, CMD --info, CMD --man), work in the usual way, and can be CMD -h/--help, CMD --info, CMD --man), work in the usual way, and can be
@ -41,12 +42,12 @@ useful.
You can type control-C to cancel a long-running command (but only once; You can type control-C to cancel a long-running command (but only once;
typing it a second time will exit the REPL). typing it a second time will exit the REPL).
And in most shells you can type control-Z to exit temporarily to the And in most shells you can type control-Z to temporarily exit to the
shell (and fg to return to the REPL). shell (and fg to bring it back to foreground and return to the REPL).
Caveats Caveats
You may find some differences in behaviour between run command lines and You may find some differences in behaviour between REPL command lines and
normal hledger command lines. For example, in the REPL, normal hledger command lines. For example, in the REPL,
- the command name must be written first, options afterward - the command name must be written first, options afterward