From bbf5dcc99b4599517885a83095f7e0ce6d4a5e17 Mon Sep 17 00:00:00 2001 From: chrisgrieser Date: Fri, 17 Mar 2023 10:29:14 +0000 Subject: [PATCH] chore: Auto generate docs --- doc/genghis.txt | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/doc/genghis.txt b/doc/genghis.txt index 112aa92..aa92a5a 100644 --- a/doc/genghis.txt +++ b/doc/genghis.txt @@ -1,4 +1,4 @@ -*genghis.txt* For NVIM v0.8.0 Last change: 2023 March 16 +*genghis.txt* For NVIM v0.8.0 Last change: 2023 March 17 ============================================================================== Table of Contents *genghis-table-of-contents* @@ -6,7 +6,7 @@ Table of Contents *genghis-table-of-contents* 1. nvim-genghis |genghis-nvim-genghis| - How is this different from vim.eunuch?|genghis-nvim-genghis-how-is-this-different-from-vim.eunuch?| - Installation and Setup |genghis-nvim-genghis-installation-and-setup| - - Available commands |genghis-nvim-genghis-available-commands| + - Available Commands |genghis-nvim-genghis-available-commands| - Autocompletion of directories|genghis-nvim-genghis-autocompletion-of-directories| - Why that name |genghis-nvim-genghis-why-that-name| - About me |genghis-nvim-genghis-about-me| @@ -20,7 +20,10 @@ Convenience file operations for neovim, written in lua. - |genghis-how-is-this-different-from-`vim.eunuch`?| - |genghis-installation-and-setup| - |genghis-available-commands| -- |genghis-autocompletion-of-filenames| + - |genghis-file-operation-command| + - |genghis-file-utility-commands| + - |genghis-disable-ex-commands| +- |genghis-autocompletion-of-directories| - |genghis-why-that-name| - |genghis-about-me| @@ -66,20 +69,26 @@ create keybindings for the commands you want to use: AVAILABLE COMMANDS *genghis-nvim-genghis-available-commands* +FILE OPERATION COMMAND ~ + + - `.createNewFile` or `:New`: Create a new file. - `.duplicateFile` or `:Duplicate`: Duplicate the current file. - `.moveSelectionToNewFile` or `:NewFromSelection`: Prompts for a new file name and moves the current selection to that new file. (Note that this is a Visual Line Mode command; the selection is moved linewise.) - `.renameFile` or `:Rename`: Rename the current file. - `.moveAndRenameFile` or `:Move`: Move and Rename the current file. Works like the UNIX `mv` command. Best used with |genghis-autocompletion-of-directories|. +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 +any non-existing folders. Except for `.moveAndRenameFile`, all operations take +only place in the current working directory, so `.moveAndRenameFile` is the +only command that can move to a parent directory. - All commands support +|genghis-autocompletion-of-existing-directories|. + + +FILE UTILITY COMMANDS ~ - **Note** The following applies to all commands above: - If no extension has - been provided, will use the extension of the original file. - If the new file - name includes a `/`, the new file is placed in the respective subdirectory, - creating any non-existing folders. Except for `.moveAndRenameFile`, all - operations take only place in the current working directory, so - `.moveAndRenameFile` is the only command that can move to a parent directory. - - All commands support |genghis-autocompletion-of-existing-directories|. - `.trashFile{trashLocation = "/your/path/"}` or `:Trash`: Move the current file to the trash location. Defaults to the operating-system-specific trash directory. ⚠️ Any existing file in the trash location with the same name is overwritten, making that file irretrievable. - `.copyFilename` or `:CopyFilename`: Copy the file name. When `clipboard="unnamed[plus]"` has been set, copies to the `+` register, otherwise to `"`. @@ -87,7 +96,7 @@ AVAILABLE COMMANDS *genghis-nvim-genghis-available-commands* - `.chmodx` or `:Chmodx`: Makes current file executable. Equivalent to `chmod +x`. -HOW TO DISABLE COMMAND-LINE COMMANDS ~ +DISABLE EX-COMMANDS ~ Put this in your configuration file: