aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/commandline.txt
diff options
context:
space:
mode:
authorGravatar ridiculousfish <corydoras@ridiculousfish.com>2014-01-17 12:53:01 -0800
committerGravatar ridiculousfish <corydoras@ridiculousfish.com>2014-01-17 12:53:01 -0800
commit32054b6f326abab45c6d1e6047b50e643be49a7b (patch)
treecdcdbf239cb094f4a7016de1df228eca649422a3 /doc_src/commandline.txt
parentc6e5201e15daf86fc25857164d51d5b9f29e0808 (diff)
Implement and document new -P / --paging-mode flags to commandline, to support new
pager
Diffstat (limited to 'doc_src/commandline.txt')
-rw-r--r--doc_src/commandline.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc_src/commandline.txt b/doc_src/commandline.txt
index ab771e96..1d13f79e 100644
--- a/doc_src/commandline.txt
+++ b/doc_src/commandline.txt
@@ -57,6 +57,16 @@ If \c commandline is called during a call to complete a given string
using <code>complete -C STRING</code>, \c commandline will consider the
specified string to be the current contents of the command line.
+The following options output metadata about the commandline state:
+
+- \c -L or \c --line print the line that the cursor is on, with the topmost
+line starting at 1
+- \c -S or \c --search-mode evaluates to true if the commandline is performing
+a history search
+- \c -P or \c --paging-mode evaluates to true if the commandline is showing
+pager contents, such as tab completions
+
+
\subsection commandline-example Example
<tt>commandline -j $history[3]</tt> replaces the job under the cursor with the