Skip to content

Commit 52b0823

Browse files
committed
More docs for choose-files
1 parent 966f2cb commit 52b0823

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/kittens/choose-files.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,33 @@ files is displayed at the bottom of the kitten and you can click on them
5555
to deselect a file. Similarly, pressing :kbd:`Shift+Enter` will un-select a
5656
previously selected file.
5757

58+
59+
Hidden and ignored files
60+
--------------------------
61+
62+
By default, the kitten does not process hidden files and directories (whose
63+
names start with a period). This can be :opt:`changed in the configuration <kitten-choose_files.show_hidden>`
64+
and also at runtime via the clickable link to the right of the search input.
65+
66+
Similarly, the kitten respects both :file:`.gitignore` and :file:`.ignore`
67+
files, by default. This can also be changed both :opt:`in configuration
68+
<kitten-choose_files.respect_ignores>` or at runtime. Note that
69+
:file:`.gitignore` files are only respected if there is also a :file:`.git`
70+
directory present. The kitten also supports the global :file:`.gitignore` file,
71+
though it applies only inside git working trees. You can specify :opt:`global ignore
72+
patterns <kitten-choose_files.ignore>`, that apply everywhere in :file:`choose-files.conf`.
73+
74+
75+
Selecting non-existent files (save file names)
76+
-------------------------------------------------
77+
78+
This kitten can also be used to select non-existent files, that is a new file
79+
for a :guilabel:`Save file` type of dialog using :option:`--mode <kitty +kitten
80+
choose_files --mode>`:code:`=save-file`. Once you have changed to the directory
81+
you want the file to be in (using the :kbd:`Tab` key),
82+
press :kbd:`Ctrl+Enter` and you will be able to type in the file name.
83+
84+
5885
Configuration
5986
------------------------
6087

0 commit comments

Comments
 (0)