Document the optional parameter of the cd command

This commit is contained in:
Frank LENORMAND 2016-10-11 10:28:45 +03:00
parent f6a2925950
commit f7e2bfd76f
3 changed files with 5 additions and 4 deletions

View File

@ -620,7 +620,7 @@ Some commands take an exclamation mark (`!`), which can be used to force
the execution of the command (i.e. to quit a modified buffer, the the execution of the command (i.e. to quit a modified buffer, the
command `q!` has to be used). command `q!` has to be used).
* `cd <directory>`: change the current directory to the one passed * `cd [<directory>]`: change the current directory to `<directory>`, or the home directory is unspecified
* `e[dit][!] <filename> [<line> [<column>]]`: open buffer on file, go to given * `e[dit][!] <filename> [<line> [<column>]]`: open buffer on file, go to given
line and column. If file is already opened, just switch to this file. line and column. If file is already opened, just switch to this file.
use edit! to force reloading. use edit! to force reloading.

View File

@ -12,8 +12,9 @@ Some commands take an exclamation mark (*!*), which can be used to force
the execution of the command (i.e. to quit a modified buffer, the the execution of the command (i.e. to quit a modified buffer, the
command *q!* has to be used). command *q!* has to be used).
*cd* <directory>:: *cd* [<directory>]::
change the current directory to the one passed change the current directory to *directory*, or the home directory if
unspecified
*e[dit][!]* <filename> [<line> [<column>]]:: *e[dit][!]* <filename> [<line> [<column>]]::
open buffer on file, go to given line and column. If file is already open buffer on file, go to given line and column. If file is already

View File

@ -1958,7 +1958,7 @@ const CommandDesc select_cmd = {
const CommandDesc change_working_directory_cmd = { const CommandDesc change_working_directory_cmd = {
"cd", "cd",
nullptr, nullptr,
"cd <dir>: change server working directory to <dir>", "cd [<directory>]: change the server's working directory to <directory>, or the home directory if unspecified",
single_optional_name_param, single_optional_name_param,
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},