michael/lf
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update doc

Browse Source 
Related #469
This commit is contained in:
Gokcehan 2020-09-22 04:22:08 +03:00
parent 7a3bd15903
commit 36798b4c24
3 changed files with 88 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
doc.go
View File

@ -46,26 +46,26 @@ The following commands are provided by lf:
echoerr echoerr
cd cd
select select
delete delete (modal)
rename (default 'r') rename (modal) (default 'r')
source source
push push
read (default ':') read (modal) (default ':')
shell (default '$') shell (modal) (default '$')
shell-pipe (default '%') shell-pipe (modal) (default '%')
shell-wait (default '!') shell-wait (modal) (default '!')
shell-async (default '&') shell-async (modal) (default '&')
find (default 'f') find (modal) (default 'f')
find-back (default 'F') find-back (modal) (default 'F')
find-next (default ';') find-next (default ';')
find-prev (default ',') find-prev (default ',')
search (default '/') search (modal) (default '/')
search-back (default '?') search-back (modal) (default '?')
search-next (default 'n') search-next (default 'n')
search-prev (default 'N') search-prev (default 'N')
mark-save (default 'm') mark-save (modal) (default 'm')
mark-load (default "'") mark-load (modal) (default "'")
mark-remove (default `"`) mark-remove (modal) (default `"`)
The following command line commands are provided by lf: The following command line commands are provided by lf:
@ -217,6 +217,7 @@ https://github.com/gokcehan/lf/blob/master/etc/lfrc.example.
Commands Commands
This section shows information about builtin commands. This section shows information about builtin commands.
Modal commands do not take any arguments, but instead change the operation mode to read their input conveniently, and so they are meant to be assigned to keybindings.
quit (default 'q') quit (default 'q')
@ -329,11 +330,11 @@ Change the working directory to the given argument.
Change the current file selection to the given argument. Change the current file selection to the given argument.
delete delete (modal)
Remove the current file or selected file(s). Remove the current file or selected file(s).
rename (default 'r') rename (modal) (default 'r')
Rename the current file using the builtin method. Rename the current file using the builtin method.
A custom 'rename' command can be defined to override this default. A custom 'rename' command can be defined to override this default.
@ -346,34 +347,34 @@ Read the configuration file given in the argument.
Simulate key pushes given in the argument. Simulate key pushes given in the argument.
read (default ':') read (modal) (default ':')
Read a command to evaluate. Read a command to evaluate.
shell (default '$') shell (modal) (default '$')
Read a shell command to execute. Read a shell command to execute.
(See also 'Prefixes' and 'Shell Commands' sections) (See also 'Prefixes' and 'Shell Commands' sections)
shell-pipe (default '%') shell-pipe (modal) (default '%')
Read a shell command to execute piping its standard I/O to the bottom statline. Read a shell command to execute piping its standard I/O to the bottom statline.
(See also 'Prefixes' and 'Piping Shell Commands' sections) (See also 'Prefixes' and 'Piping Shell Commands' sections)
shell-wait (default '!') shell-wait (modal) (default '!')
Read a shell command to execute and wait for a key press in the end. Read a shell command to execute and wait for a key press in the end.
(See also 'Prefixes' and 'Waiting Shell Commands' sections) (See also 'Prefixes' and 'Waiting Shell Commands' sections)
shell-async (default '&') shell-async (modal) (default '&')
Read a shell command to execute synchronously without standard I/O. Read a shell command to execute synchronously without standard I/O.
find (default 'f') find (modal) (default 'f')
find-back (default 'F') find-back (modal) (default 'F')
find-next (default ';') find-next (default ';')
find-prev (default ',') find-prev (default ',')
@ -390,15 +391,16 @@ Read a pattern to search for a file name match in the forward/backward direction
(See also 'globsearch', 'incsearch', 'wrapscan', 'ignorecase', 'smartcase', 'ignoredia', and 'smartdia' options and 'Searching Files' section) (See also 'globsearch', 'incsearch', 'wrapscan', 'ignorecase', 'smartcase', 'ignoredia', and 'smartdia' options and 'Searching Files' section)
mark-save (default 'm') mark-save (modal) (default 'm')
Save the current directory as a bookmark assigned to the given key. Save the current directory as a bookmark assigned to the given key.
mark-load (default "'") mark-load (modal) (default "'")
Change the current directory to the bookmark assigned to the given key. Change the current directory to the bookmark assigned to the given key.
A special bookmark "'" holds the previous directory after a 'mark-load', 'cd', or 'select' command.
mark-remove (default `"`) mark-remove (modal) (default `"`)
Remove a bookmark assigned to the given key. Remove a bookmark assigned to the given key.

60
docstring.go
View File

@ -49,26 +49,26 @@ The following commands are provided by lf:
echoerr echoerr
cd cd
select select
delete delete (modal)
rename (default 'r') rename (modal) (default 'r')
source source
push push
read (default ':') read (modal) (default ':')
shell (default '$') shell (modal) (default '$')
shell-pipe (default '%') shell-pipe (modal) (default '%')
shell-wait (default '!') shell-wait (modal) (default '!')
shell-async (default '&') shell-async (modal) (default '&')
find (default 'f') find (modal) (default 'f')
find-back (default 'F') find-back (modal) (default 'F')
find-next (default ';') find-next (default ';')
find-prev (default ',') find-prev (default ',')
search (default '/') search (modal) (default '/')
search-back (default '?') search-back (modal) (default '?')
search-next (default 'n') search-next (default 'n')
search-prev (default 'N') search-prev (default 'N')
mark-save (default 'm') mark-save (modal) (default 'm')
mark-load (default "'") mark-load (modal) (default "'")
mark-remove (default '"') mark-remove (modal) (default '"')
The following command line commands are provided by lf: The following command line commands are provided by lf:
@ -222,7 +222,9 @@ https://github.com/gokcehan/lf/blob/master/etc/lfrc.example.
Commands Commands
This section shows information about builtin commands. This section shows information about builtin commands. Modal commands do not
take any arguments, but instead change the operation mode to read their
input conveniently, and so they are meant to be assigned to keybindings.
quit (default 'q') quit (default 'q')
@ -343,11 +345,11 @@ Change the working directory to the given argument.
Change the current file selection to the given argument. Change the current file selection to the given argument.
delete delete (modal)
Remove the current file or selected file(s). Remove the current file or selected file(s).
rename (default 'r') rename (modal) (default 'r')
Rename the current file using the builtin method. A custom 'rename' command Rename the current file using the builtin method. A custom 'rename' command
can be defined to override this default. can be defined to override this default.
@ -360,35 +362,35 @@ Read the configuration file given in the argument.
Simulate key pushes given in the argument. Simulate key pushes given in the argument.
read (default ':') read (modal) (default ':')
Read a command to evaluate. Read a command to evaluate.
shell (default '$') shell (modal) (default '$')
Read a shell command to execute. Read a shell command to execute.
(See also 'Prefixes' and 'Shell Commands' sections) (See also 'Prefixes' and 'Shell Commands' sections)
shell-pipe (default '%') shell-pipe (modal) (default '%')
Read a shell command to execute piping its standard I/O to the bottom Read a shell command to execute piping its standard I/O to the bottom
statline. statline.
(See also 'Prefixes' and 'Piping Shell Commands' sections) (See also 'Prefixes' and 'Piping Shell Commands' sections)
shell-wait (default '!') shell-wait (modal) (default '!')
Read a shell command to execute and wait for a key press in the end. Read a shell command to execute and wait for a key press in the end.
(See also 'Prefixes' and 'Waiting Shell Commands' sections) (See also 'Prefixes' and 'Waiting Shell Commands' sections)
shell-async (default '&') shell-async (modal) (default '&')
Read a shell command to execute synchronously without standard I/O. Read a shell command to execute synchronously without standard I/O.
find (default 'f') find (modal) (default 'f')
find-back (default 'F') find-back (modal) (default 'F')
find-next (default ';') find-next (default ';')
find-prev (default ',') find-prev (default ',')
@ -409,15 +411,17 @@ direction and jump to the next/previous match.
(See also 'globsearch', 'incsearch', 'wrapscan', 'ignorecase', 'smartcase', (See also 'globsearch', 'incsearch', 'wrapscan', 'ignorecase', 'smartcase',
'ignoredia', and 'smartdia' options and 'Searching Files' section) 'ignoredia', and 'smartdia' options and 'Searching Files' section)
mark-save (default 'm') mark-save (modal) (default 'm')
Save the current directory as a bookmark assigned to the given key. Save the current directory as a bookmark assigned to the given key.
mark-load (default "'") mark-load (modal) (default "'")
Change the current directory to the bookmark assigned to the given key. Change the current directory to the bookmark assigned to the given key. A
special bookmark "'" holds the previous directory after a 'mark-load', 'cd',
or 'select' command.
mark-remove (default '"') mark-remove (modal) (default '"')
Remove a bookmark assigned to the given key. Remove a bookmark assigned to the given key.

56
lf.1
View File

@ -56,26 +56,26 @@ The following commands are provided by lf:
echoerr echoerr
cd cd
select select
delete delete (modal)
rename (default 'r') rename (modal) (default 'r')
source source
push push
read (default ':') read (modal) (default ':')
shell (default '$') shell (modal) (default '$')
shell-pipe (default '%') shell-pipe (modal) (default '%')
shell-wait (default '!') shell-wait (modal) (default '!')
shell-async (default '&') shell-async (modal) (default '&')
find (default 'f') find (modal) (default 'f')
find-back (default 'F') find-back (modal) (default 'F')
find-next (default ';') find-next (default ';')
find-prev (default ',') find-prev (default ',')
search (default '/') search (modal) (default '/')
search-back (default '?') search-back (modal) (default '?')
search-next (default 'n') search-next (default 'n')
search-prev (default 'N') search-prev (default 'N')
mark-save (default 'm') mark-save (modal) (default 'm')
mark-load (default "'") mark-load (modal) (default "'")
mark-remove (default `"`) mark-remove (modal) (default `"`)
.EE .EE
.PP .PP
The following command line commands are provided by lf: The following command line commands are provided by lf:
@ -243,7 +243,7 @@ You can configure the default values of following variables to change these loca
.PP .PP
A sample configuration file can be found at https://github.com/gokcehan/lf/blob/master/etc/lfrc.example. A sample configuration file can be found at https://github.com/gokcehan/lf/blob/master/etc/lfrc.example.
.SH COMMANDS .SH COMMANDS
This section shows information about builtin commands. This section shows information about builtin commands. Modal commands do not take any arguments, but instead change the operation mode to read their input conveniently, and so they are meant to be assigned to keybindings.
.PP .PP
.EX .EX
quit (default 'q') quit (default 'q')
@ -398,13 +398,13 @@ Change the working directory to the given argument.
Change the current file selection to the given argument. Change the current file selection to the given argument.
.PP .PP
.EX .EX
delete delete (modal)
.EE .EE
.PP .PP
Remove the current file or selected file(s). Remove the current file or selected file(s).
.PP .PP
.EX .EX
rename (default 'r') rename (modal) (default 'r')
.EE .EE
.PP .PP
Rename the current file using the builtin method. A custom 'rename' command can be defined to override this default. Rename the current file using the builtin method. A custom 'rename' command can be defined to override this default.
@ -422,13 +422,13 @@ Read the configuration file given in the argument.
Simulate key pushes given in the argument. Simulate key pushes given in the argument.
.PP .PP
.EX .EX
read (default ':') read (modal) (default ':')
.EE .EE
.PP .PP
Read a command to evaluate. Read a command to evaluate.
.PP .PP
.EX .EX
shell (default '$') shell (modal) (default '$')
.EE .EE
.PP .PP
Read a shell command to execute. Read a shell command to execute.
@ -436,7 +436,7 @@ Read a shell command to execute.
(See also 'Prefixes' and 'Shell Commands' sections) (See also 'Prefixes' and 'Shell Commands' sections)
.PP .PP
.EX .EX
shell-pipe (default '%') shell-pipe (modal) (default '%')
.EE .EE
.PP .PP
Read a shell command to execute piping its standard I/O to the bottom statline. Read a shell command to execute piping its standard I/O to the bottom statline.
@ -444,7 +444,7 @@ Read a shell command to execute piping its standard I/O to the bottom statline.
(See also 'Prefixes' and 'Piping Shell Commands' sections) (See also 'Prefixes' and 'Piping Shell Commands' sections)
.PP .PP
.EX .EX
shell-wait (default '!') shell-wait (modal) (default '!')
.EE .EE
.PP .PP
Read a shell command to execute and wait for a key press in the end. Read a shell command to execute and wait for a key press in the end.
@ -452,14 +452,14 @@ Read a shell command to execute and wait for a key press in the end.
(See also 'Prefixes' and 'Waiting Shell Commands' sections) (See also 'Prefixes' and 'Waiting Shell Commands' sections)
.PP .PP
.EX .EX
shell-async (default '&') shell-async (modal) (default '&')
.EE .EE
.PP .PP
Read a shell command to execute synchronously without standard I/O. Read a shell command to execute synchronously without standard I/O.
.PP .PP
.EX .EX
find (default 'f') find (modal) (default 'f')
find-back (default 'F') find-back (modal) (default 'F')
find-next (default ';') find-next (default ';')
find-prev (default ',') find-prev (default ',')
.EE .EE
@ -480,19 +480,19 @@ Read a pattern to search for a file name match in the forward/backward direction
(See also 'globsearch', 'incsearch', 'wrapscan', 'ignorecase', 'smartcase', 'ignoredia', and 'smartdia' options and 'Searching Files' section) (See also 'globsearch', 'incsearch', 'wrapscan', 'ignorecase', 'smartcase', 'ignoredia', and 'smartdia' options and 'Searching Files' section)
.PP .PP
.EX .EX
mark-save (default 'm') mark-save (modal) (default 'm')
.EE .EE
.PP .PP
Save the current directory as a bookmark assigned to the given key. Save the current directory as a bookmark assigned to the given key.
.PP .PP
.EX .EX
mark-load (default "'") mark-load (modal) (default "'")
.EE .EE
.PP .PP
Change the current directory to the bookmark assigned to the given key. Change the current directory to the bookmark assigned to the given key. A special bookmark "'" holds the previous directory after a 'mark-load', 'cd', or 'select' command.
.PP .PP
.EX .EX
mark-remove (default `"`) mark-remove (modal) (default `"`)
.EE .EE
.PP .PP
Remove a bookmark assigned to the given key. Remove a bookmark assigned to the given key.