chore: Auto generate docs

remotes/origin/HEAD
chrisgrieser 2024-01-01 15:49:33 +00:00 committed by github-actions[bot]
parent 9cbd4eec84
commit 12123cdd40
1 changed files with 10 additions and 18 deletions

View File

@ -17,7 +17,7 @@ Table of Contents *genghis-table-of-contents*
Lightweightfile operations without a full-blown file management plugin.
Lightweightand quick file operations without being a full-blown file manager.
- |genghis-features|
- |genghis-installation-and-setup|
@ -86,17 +86,17 @@ FILE OPERATION COMMAND ~
Line Mode command; the selection is moved linewise.)
- `.renameFile` or `:Rename`Rename the current file.
- `.moveAndRenameFile` or `:Move`Move and Rename the current file. Keeps the
old name if the new path ends with `/`. Works like the UNIX `mv` command. Best
old name if the new path ends with `/`. Works like the UNIX `mv` command. Can be
used with |genghis-autocompletion-of-directories|.
- `.trashFile`Trash the current file.
- Use `trashCmd` to specify an external trash command. It defaults to
`gio trash` on _Linux_, `trash` on _Mac_ and _Windows_.
- Otherwise specify `trashLocation` to move the file to that directory. It
defaults to `$HOME/.Trash`. This does NOT trash the file the usual way. The
trashed file is NOT restorable to its original path.
- For backwards compatibility, the default behavior on _Mac_ moves files to
`$HOME/.Trash`.
- `.trashFile{trashCmd = "your_cli"}` or `:Trash`Move the current file
to the trash location.
- Defaults to `gio trash` on _Linux_, `trash` on _Mac_ and _Windows_.
- If bufdelete.nvim <https://github.com/famiu/bufdelete.nvim> is available,
`require'bufdelete.nvim'.bufwipeout` would be used to keep window layout
intact instead of `vim.cmd.bwipeout`.
[!NOTE] The trash CLIs are not available by default, and must be installed.
The following applies to all commands above: - If no extension has been
provided, uses the extension of the original file. - If the new file name
includes a `/`, the new file is placed in the respective subdirectory, creating
@ -113,14 +113,6 @@ statements.
FILE UTILITY COMMANDS ~
- `.trashFile{trashLocation = "/your/path/"}` or `:Trash`Move the current file
to the trash location. Defaults to the operating-system-specific trash
directory. <https://github.com/chrisgrieser/nvim-genghis/blob/main/lua/genghis.lua#L164>
Any existing file in the trash location with the same name is overwritten,
making that file irretrievable. If
bufdelete.nvim <https://github.com/famiu/bufdelete.nvim> is available,
`require'bufdelete.nvim'.bufwipeout` would be used to keep window layout intact
instead of `vim.cmd.bwipeout`.
- `.copyFilename` or `:CopyFilename`Copy the file name. When
`clipboard="unnamed[plus]"` has been set, copies to the `+` register, otherwise
to `"`.