From 52b0823470b50a9334b60b56a6718c3ae8f66f82 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Wed, 16 Jul 2025 19:22:20 +0530 Subject: [PATCH] More docs for choose-files --- docs/kittens/choose-files.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/kittens/choose-files.rst b/docs/kittens/choose-files.rst index 305f08f3a..241d87513 100644 --- a/docs/kittens/choose-files.rst +++ b/docs/kittens/choose-files.rst @@ -55,6 +55,33 @@ files is displayed at the bottom of the kitten and you can click on them to deselect a file. Similarly, pressing :kbd:`Shift+Enter` will un-select a previously selected file. + +Hidden and ignored files +-------------------------- + +By default, the kitten does not process hidden files and directories (whose +names start with a period). This can be :opt:`changed in the configuration ` +and also at runtime via the clickable link to the right of the search input. + +Similarly, the kitten respects both :file:`.gitignore` and :file:`.ignore` +files, by default. This can also be changed both :opt:`in configuration +` or at runtime. Note that +:file:`.gitignore` files are only respected if there is also a :file:`.git` +directory present. The kitten also supports the global :file:`.gitignore` file, +though it applies only inside git working trees. You can specify :opt:`global ignore +patterns `, that apply everywhere in :file:`choose-files.conf`. + + +Selecting non-existent files (save file names) +------------------------------------------------- + +This kitten can also be used to select non-existent files, that is a new file +for a :guilabel:`Save file` type of dialog using :option:`--mode `:code:`=save-file`. Once you have changed to the directory +you want the file to be in (using the :kbd:`Tab` key), +press :kbd:`Ctrl+Enter` and you will be able to type in the file name. + + Configuration ------------------------