fish-shell/doc_src/commandline.txt

\section commandline commandline - set or get the current command line buffer

\subsection commandline-synopsis Synopsis
<tt>commandline [OPTIONS] [CMD]</tt>

\subsection commandline-description Description

\c commandline can be used to set or get the current contents of the command
line buffer.

With no parameters, \c commandline returns the current value of the command
line.

With \c CMD specified, the command line buffer is erased and replaced with
the contents of \c CMD.

The following options are available:

- \c -C or \c --cursor set or get the current cursor position, not
  the contents of the buffer. If no argument is given, the current
  cursor position is printed, otherwise the argument is interpreted
  as the new cursor position.
- \c -f or \c --function inject readline functions into the
  reader. This option cannot be combined with any other option. It
  will cause any additional arguments to be interpreted as readline
  functions, and these functions will be injected into the reader, so
  that they will be returned to the reader before any additional
  actual key presses are read.

The following options change the way \c commandline updates the
command line buffer:

- \c -a or \c --append do not remove the current commandline, append
  the specified string at the end of it
- \c -i or \c --insert do not remove the current commandline, insert
  the specified string at the current cursor position
- \c -r or \c --replace remove the current commandline and replace it
  with the specified string (default)

The following options change what part of the commandline is printed
or updated:

- \c -b or \c --current-buffer select the entire buffer (default)
- \c -j or \c --current-job select the current job
- \c -p or \c --current-process select the current process
- \c -t or \c --current-token select the current token.

The following options change the way \c commandline prints the current
commandline buffer:

- \c -c or \c --cut-at-cursor only print selection up until the
  current cursor position
- \c -o or \c --tokenize tokenize the selection and print one string-type token per line


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
third item from the command line history.
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`\section commandline commandline - set or get the current command line buffer`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
			`\subsection commandline-synopsis Synopsis`
			`<tt>commandline [OPTIONS] [CMD]</tt>`

			`\subsection commandline-description Description`

Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`\c commandline can be used to set or get the current contents of the command`
			`line buffer.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`With no parameters, \c commandline returns the current value of the command`
			`line.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`With \c CMD specified, the command line buffer is erased and replaced with`
			`the contents of \c CMD.`

			`The following options are available:`
Add the possibility to set the cursor position using the commandline builtin darcs-hash:20061004213948-ac50b-3f673edeb01390bb3f280812d90bc8469f2f8ba8.gz 2006-10-05 05:39:48 +08:00
remove trialing spaces #2 2010-09-18 10:18:26 +08:00			`- \c -C or \c --cursor set or get the current cursor position, not`
Add the possibility to set the cursor position using the commandline builtin darcs-hash:20061004213948-ac50b-3f673edeb01390bb3f280812d90bc8469f2f8ba8.gz 2006-10-05 05:39:48 +08:00			`the contents of the buffer. If no argument is given, the current`
remove trialing spaces #2 2010-09-18 10:18:26 +08:00			`cursor position is printed, otherwise the argument is interpreted`
Add the possibility to set the cursor position using the commandline builtin darcs-hash:20061004213948-ac50b-3f673edeb01390bb3f280812d90bc8469f2f8ba8.gz 2006-10-05 05:39:48 +08:00			`as the new cursor position.`
			`- \c -f or \c --function inject readline functions into the`
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`reader. This option cannot be combined with any other option. It`
Add the possibility to set the cursor position using the commandline builtin darcs-hash:20061004213948-ac50b-3f673edeb01390bb3f280812d90bc8469f2f8ba8.gz 2006-10-05 05:39:48 +08:00			`will cause any additional arguments to be interpreted as readline`
			`functions, and these functions will be injected into the reader, so`
			`that they will be returned to the reader before any additional`
Minor code edits. Add curly brackets in various places, add or rewrite various comments, fix indentation, etc. darcs-hash:20070121150114-ac50b-4fd6965cb2c557178923f8afa944835166e08423.gz 2007-01-21 23:01:14 +08:00			`actual key presses are read.`
Add the possibility to set the cursor position using the commandline builtin darcs-hash:20061004213948-ac50b-3f673edeb01390bb3f280812d90bc8469f2f8ba8.gz 2006-10-05 05:39:48 +08:00
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`The following options change the way \c commandline updates the`
			`command line buffer:`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
			`- \c -a or \c --append do not remove the current commandline, append`
			`the specified string at the end of it`
			`- \c -i or \c --insert do not remove the current commandline, insert`
			`the specified string at the current cursor position`
			`- \c -r or \c --replace remove the current commandline and replace it`
			`with the specified string (default)`

Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`The following options change what part of the commandline is printed`
			`or updated:`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
			`- \c -b or \c --current-buffer select the entire buffer (default)`
			`- \c -j or \c --current-job select the current job`
			`- \c -p or \c --current-process select the current process`
Fix typo in documentation for the commandline builtin. Thanks to Reuben Thomas for reporting this. darcs-hash:20061103143140-ac50b-b37fbfe68321f904936c002010045e467bc3a778.gz 2006-11-03 22:31:40 +08:00			`- \c -t or \c --current-token select the current token.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`The following options change the way \c commandline prints the current`
			`commandline buffer:`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
			`- \c -c or \c --cut-at-cursor only print selection up until the`
			`current cursor position`
Fixed various spelling mistakes. darcs-hash:20060123231706-35ec8-2a30db603eee503d944b06d101cc88ce59340309.gz 2006-01-24 07:17:06 +08:00			`- \c -o or \c --tokenize tokenize the selection and print one string-type token per line`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00

Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`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.`
Add not on commandline behaviour when using complete -C to documentation darcs-hash:20060131214646-ac50b-dc7b1510ceefc7645061d91bbe5022c09c209a34.gz 2006-02-01 05:46:46 +08:00
Implement and document new -P / --paging-mode flags to commandline, to support new pager 2014-01-18 04:53:01 +08:00			`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`


Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00			`\subsection commandline-example Example`

Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`<tt>commandline -j $history[3]</tt> replaces the job under the cursor with the`
			`third item from the command line history.`