Debian Codegraph @

misc/clifmrc

raw
1 ###########################################
2 # CLIFM #
3 # The Command-Line File Manager #
4 ###########################################
5
6 # This is Clifm's main configuration file.
7
8 # Lines starting with either '#' or ';' are commented out (ignored).
9 # Options starting with ';' show default values and are commented out.
10 # To override a default, uncomment the corresponding option (remove
11 # the leading ';') and set it to a supported value.
12
13
14 #=====================================#
15 # 1. INTERFACE #
16 #=====================================#
17
18 # Show hidden files (i.e., files starting with a dot).
19 # Supported values: true, false, first, last.
20 # If 'true', hidden files are sorted according to the value of the Sort
21 # option (see below).
22 ;ShowHiddenFiles=false
23
24 # Files listed in a '.hidden' file in the current directory are hidden when
25 # hidden files are not shown (i.e., when ShowHiddenFiles is set to false).
26 # Both plain filenames and wildcards are supported for specifying hidden files.
27 ;ReadDotHidden=false
28
29 # Regular expression to filter files from the file list.
30 # For example: "!.*~$" to exclude backup files (ending with ~), or "^\." to
31 # list only hidden files. File type filters are also supported, such as
32 # "=d" to list directories only, or "!=l" to exclude symbolic links.
33 # Run 'help file-filters' for more information.
34 ;Filter=""
35
36 # List directories before files.
37 ;ListDirsFirst=true
38
39 # Display the number of files inside each directory next to the directory
40 # name. This feature may slow down performance when, for example, listing
41 # files on a remote server: the file counter can be disabled here, via
42 # the --no-file-counter option, or using the 'fc' command while in the
43 # program itself.
44 # Note: This option requires Classify (see below) to be set to true.
45 ;FileCounter=true
46
47 # When colors are enabled, append directory indicator to directories. When
48 # colors are disabled (via the --no-color option), append file type
49 # indicator to filenames instead:
50 # '/' for directories
51 # '@' for symbolic links
52 # '=' for sockets
53 # '|' for FIFO/pipes
54 # '*' for for executable files
55 # '+' for block special files
56 # '-' for character special files
57 # '?' for unknown file types
58 # Bear in mind that when running in light mode the check for executable
59 # files is not performed, and thereby no indicator is added to executable
60 # files.
61 # Note: Disabling this option also disables the file counter.
62 ;Classify=true
63
64 # Dereference symbolic links when listing files
65 ;FollowSymlinks=true
66
67 # Colorize symbolic links according to their target. A link indicator
68 # (by default '@') is prefixed to the file name.
69 # The color of this indicator can be customized in the color scheme file
70 # (InterfaceColors field) using the 'lc' code.
71 ;ColorizeSymlinksAsTarget=false
72
73 # Control the use of the file list pager. Supported values are:
74 # 0/false = Disable the pager.
75 # 1/true = Run the pager when the file list does not fit on the screen.
76 # >1 = Run the pager when the number of files in the current directory
77 # is greater than or equal to this value (e.g., 1000).
78 ;Pager=false
79
80 # Pager listing mode. Supported values:
81 # auto = Use the current listing mode
82 # long = List files in long view
83 # short = List files in short view
84 ;PagerView=auto
85
86 # File listing layout: 0 = vertical (like ls), 1 = horizontal.
87 ;ListingMode=0
88
89 # Sort methods: none, name, version, extension, type, blocks, size
90 # links, atime, btime, ctime, mtime, inode, owner, and group.
91 ;Sort=version
92
93 # Invert sort order. You can also use the --sort-reverse option
94 # or the 'st rev' command.
95 ;SortReverse=false
96
97 # Sort filenames starting with the specified characters first.
98 # Multiple values are allowed (e.g., 'PrioritySortChar=._#')
99 # Leave empty to unset this option (no priority character).
100 # Supported values are ASCII characters from SPACE to TILDE.
101 # Tip: A common value for this option is underscore (_).
102 # Note: This option takes precedence over SkipNonAlnumPrefix (see below).
103 ;PrioritySortChar=
104
105 # Display extended file metadata next to filenames (long listing format).
106 ;LongViewMode=false
107
108 # Specify which properties to display for each filename in long view mode:
109 # f = File counter (for directories)
110 # B = File allocated blocks
111 # d = Inode number
112 # l = Number of hard links
113 # p|n = Permissions: either symbolic (p) or numeric/octal (n)
114 # i|I = User/group IDs: either as number (i) or name (I)
115 # G = If i|I is set, don't print groups
116 # a|b|m|c = Last (a)ccess, (b)irth, (m)odification, or status (c)hange time
117 # s|S = Size (either human readable (s) or bytes (S))
118 # x = Extended attributes/capabilities/ACLs (marked as '@')
119 # (requires p|n)
120 #
121 # A single dash ("-") disables all fields.
122 #
123 # Note that, exception made of 'x' and 'G', fields are displayed in the
124 # order specified here.
125 #
126 # Example: display only permissions (numeric) and size (human readable):
127 #PropFields="ns"
128 # or, to display file permissions, modification time, and size (in bytes):
129 #PropFields="pmS"
130 ;PropFields="xfpIsm"
131
132 # Number of spaces between fields in long view. Possible values: 1 or 2.
133 ;PropFieldsGap=1
134
135 # Style for printing timestamps in long view mode.
136 # Supported values: default, relative, iso, long-iso, full-iso, +FORMAT
137 # FORMAT is interpreted like in strftime(3).
138 # Defaults to "+%b %e %H:%M" for recent files (< 6 months) and "+%b %e %Y"
139 # for older files.
140 # Examples:
141 ;TimeStyle=full-iso
142 ;TimeStyle=relative
143 ;TimeStyle="+%F %T"
144
145 # If sorting by time in the file list, use the same timestamp in long view
146 # mode, regardless of the value set in PropFields.
147 ;TimeFollowsSort=true
148
149 # Append an indicator ('a', 'b', 'c', or 'm') to the timestamp in long view
150 # mode to indicate the type of timestamp: access, birth, status change, or
151 # modification time, respectively. When using relative times, uppercase
152 # characters are used for improved visibility.
153 ;TimestampMark=false
154
155 # Similar to TimeStyle, but specific to the 'p/pp' command.
156 # Supported values: default, iso, long-iso, full-iso, full-iso-nano, +FORMAT
157 # Nano-second precision is available using the %N modifier.
158 ;PTimeStyle="+%Y-%m-%d %H:%M:%S.%N %z"
159
160 # Display recursive directory sizes (long view only).
161 ;FullDirSize=false
162
163 # Display apparent file sizes (logical size) instead of actual device
164 # usage (physical size).
165 ;ApparentSize=true
166
167 # The light mode disables extra file-type checks to improve speed (no
168 # readability/executability/SUID/SGID/broken-symlink checks). The
169 # color-per-extension check is also disabled.
170 ;LightMode=false
171
172 # Clear the terminal screen before listing files.
173 # Supported values: true, false, internal (restrict this behavior to
174 # internal commands only: shell commands will not clear the screen).
175 # Note: If set to 'internal', the current list of files will not be refreshed
176 # even if an external command creates, removes, or renames a file in the
177 # current directory.
178 ;ClearScreen=true
179
180 # Maximum filename length for displayed files. If TruncateNames is enabled,
181 # names longer than MaxFilenameLen are truncated with a tilde (~).
182 # Set to -1, 'unset' (or leave empty) to disable the limit.
183 # Set to a percentage (e.g., 20%) to use that fraction of terminal columns.
184 # Note: if the computed value is below MinNameTruncate, MinNameTruncate is
185 # used instead.
186 ;MaxFilenameLen=25%
187
188 # Truncate filenames longer than MaxFilenameLen.
189 ;TruncateNames=true
190
191 # Minimum length at which a filename can be truncated.
192 ;MinNameTruncate=20
193
194 # A comma separated list of workspace names in the format NUM=NAME.
195 # Example: "1=MAIN,2=EXTRA,3=GIT" or "1=α,2=β,3=γ"
196 ;WorkspaceNames=""
197
198 # If set to true, settings changed in the current workspace (only via
199 # the command line or keyboard shortcuts) are kept private to that
200 # workspace and made persistent (for the current session only), even
201 # when switching workspaces.
202 ;PrivateWorkspaceSettings=false
203
204 # Show disk usage of the filesystem where the current directory resides,
205 # in the format "FREE % (FREE/TOTAL) TYPE DEVICE".
206 ;DiskUsage=false
207
208 # Print a map of the current position in the directory history list,
209 # showing previous, current, and next entries.
210 ;DirhistMap=false
211
212 # Print the list of selected files after the file list. Since this
213 # list can become extensive, you can limit the number of printed
214 # entries using the MaxPrintSelfiles option below.
215 ;PrintSelfiles=false
216
217 # Maximum number of selected files to be printed if PrinSelFiles is
218 # enabled. Supported values: -1 = no limit, 0 = auto (never print more
219 # than half terminal height), or any positive value.
220 ;MaxPrintSelfiles=0
221
222 # Color schemes (or just themes) are stored in the colors directory
223 # ($XDG_DATA_DIRS/clifm/colors, usually /usr/local/share/clifm/colors
224 # or /usr/share/clifm/colors). You can place your custom themes in
225 # $HOME/.config/clifm/colors.
226 #
227 # Use the 'cs' command or the '--color-scheme' command-line option to set
228 # a theme.
229 #
230 # Run 'cs edit' to modify the current theme.
231 #
232 # Each theme includes color definitions, just as definitions for the
233 # prompt, the warning prompt, the dividing line, and the FZF window.
234 #
235 # Use TAB to list available themes: 'cs <TAB>'.
236 #
237 # For additional themes, visit https://github.com/leo-arch/clifm-colors.
238 #
239 # Defaults to 'default-256', or 'default' (16 colors) if 256-color support
240 # is not detected.
241 ;ColorScheme=
242
243 # Enable the use of icons in the file list.
244 # By default, Nerdfonts are used as icon set, but emojis and icons-in-terminal
245 # are supported as well (requires recompilation). Consult our Wiki
246 # (https://github.com/leo-arch/clifm/wiki) for more information.
247 ;Icons=false
248
249 # Number of spaces between icons and filenames (supported values: 0, 1, or 2).
250 ;IconsGap=1
251
252
253 #=====================================#
254 # 2. COMMAND LINE #
255 #=====================================#
256
257 # Quoting style used to expand ELNs (regular files only).
258 # Supported values: 'backslash' (default), 'single', or 'double' quotes.
259 # This option is particularly useful for shells that do not support
260 # backslashes as quoting mechanism, such as nushell or xonsh.
261 ;QuotingStyle=backslash
262
263 # Enable fuzzy matching for filename/path completion and suggestions.
264 ;FuzzyMatching=false
265
266 # Choose the fuzzy matching algorithm to use. Supported values:
267 # 1 = faster, but not Unicode aware
268 # 2 = slower, but Unicode aware (note that this algorithm will nonetheless
269 # fall back to the first one whenever the query string does not contain
270 # Unicode characters, minimizing thus the performance impact).
271 ;FuzzyAlgorithm=2
272
273 # Set the tab completion mode. Supported values: standard, fzf, fnf, smenu.
274 # Defaults to 'fzf', 'fnf', or 'smenu' (in this order), if the corresponding
275 # binary is found in PATH. Othwerwise, the standard mode is used.
276 ;TabCompletionMode=
277
278 # Enable file previews for tab completion (fzf mode only). Supported values:
279 # true, false, hidden (enabled, but hidden; toggle with Alt-p).
280 ;FzfPreview=true
281
282 # Do not preview files exceeding the specified size.
283 # Supported size units: K, M, G, T (e.g., 100M).
284 # Supported size range: 1K-2047G.
285 # Set to -1 (or leave empty) to disable this feature (allow all file sizes).
286 ;PreviewMaxSize=
287
288 # Enable auto-suggestions for commands, file paths, and options as you type.
289 ;AutoSuggestions=true
290
291 # The following suggestion checks are performed in the order specified
292 # by SuggestionStrategy. Available checks include:
293 # a = Alias names
294 # c = Path completion
295 # e = ELNs
296 # f = Filenames in current directory
297 # h = Command history
298 # j = Jump database
299 # Use a single dash (-) to skip all of these checks.
300 ;SuggestionStrategy=ehfjac
301
302 # Suggest filenames using the corresponding file type color (as defined in
303 # the color scheme file).
304 ;SuggestFiletypeColor=false
305
306 # Provide a brief description for internal commands as part of the suggestions.
307 ;SuggestCmdDesc=true
308
309 # Enable syntax highlighting for improved readability of commands as you type.
310 ;SyntaxHighlighting=true
311
312 # Allow the execution of external shell commands within Clifm.
313 ;ExternalCommands=true
314
315
316 #=====================================#
317 # 3. COMMANDS #
318 #=====================================#
319
320 # Automatically list files after changing the current directory.
321 ;AutoLs=true
322
323 # If enabled, a command name that is the name of a directory or a
324 # file, is executed as if it were the argument to the 'cd' or the
325 # 'open' commands respectively: 'DIR' is equivalent 'cd DIR' and
326 # 'FILE' to 'open FILE'.
327 ;Autocd=true
328 ;AutoOpen=true
329
330 # Execute autocommand files (.cfm.in and .cfm.out) found in the current
331 # directory. For more information consult the manpage.
332 ;ReadAutocmdFiles=false
333
334 # Inform about autocommand options set for the current directory.
335 # Supported values:
336 # none = No message is displayed.
337 # mini = Minimal message with no option details.
338 # short = List of autocommand options without their values.
339 # long = Like 'short', but includes the value of each option (multiple
340 # matching autocommands are merged into a single line).
341 # full = Like 'long', but multiple autocommands are printed on separate
342 # lines. Also, a 'T' is appended to mark temporary autocommands
343 # (i.e., set via the 'auto' command).
344 # prompt = Display a small notification (a gray 'A') in the prompt.
345 # The color code used for this notification is 'ac' (see the color
346 # scheme file).
347 # If Notifications is set to false for the current prompt (see the
348 # prompts file), nothing is printed (you can use the '\y' prompt
349 # code in the prompts file to manually set this notification).
350 ;InformAutocmd=prompt
351
352 # Run in read-only mode (internal commands able to modify the filesystem
353 # are disabled). Consult the manpage for the list of affected commands.
354 ;Readonly=false
355
356 # Make the 'r' command move files to the trash instead of permanently
357 # removing them.
358 ;TrashAsRm=false
359
360 # If set to true, do not ask for confirmation before moving files to the trash.
361 ;TrashForce=false
362
363 # If set to true, do not ask for confirmation before removing files with the
364 # 'r' command.
365 # Note: If set to false, you can still use the '-f' parameter to turn
366 # confirmation off for a single command. E.g., 'r -f FILE'.
367 ;rmForce=false
368
369 # Warn about unsafe filenames when creating/renaming files ('n' and 'm'
370 # commands respectively). Supported values:
371 # false = No check is performed
372 # basic = Only basic checks are performed
373 # strict = Basic + disallow shell metacharacters
374 # posix = Basic + allow only characters in the Portable Character Set
375 # Consult the manpage for details.
376 ;SafeFilenames=basic
377
378 # Set the default command used for copying files. Supported values:
379 # 0 = 'cp -Rp'
380 # 1 = 'cp -Rp' (force: do not prompt before overwrite)
381 # 2 = 'advcp -gRp'
382 # 3 = 'advcp -gRp' (force)
383 # 4 = 'wcp'
384 # 5 = 'rsync -avP'
385 # Note: Options 2-5 include a progress bar.
386 ;cpCmd=0
387
388 # Set the default command used for moving files. Supported values:
389 # 0 = 'mv'
390 # 1 = 'mv' (force: do not prompt before overwrite)
391 # 2 = 'advmv -g'
392 # 3 = 'advmv -g' (force)
393 # Note: Options 2 and 3 include a progress bar.
394 ;mvCmd=0
395
396 # Define default responses for confirmation prompts using a comma-separated
397 # line of fields. Each field consists of two values separated by a colon (':').
398 #
399 # The left value specifies a confirmation prompt:
400 # o = overwrite files (mostly 'c' and 'm' commands)
401 # r = remove ('r' command)
402 # t = trash ('t' command)
403 # R = bulk rename ('br' command)
404 # d = All confirmation prompts (excluding, if defined, the above ones)
405 # D = All confirmation prompts (including the above ones, no matter their value)
406 #
407 # The right value holds the default answer for the corresponding prompt:
408 # 'y', 'n', or 'u' (unset - no default answer, wait for explicit input).
409 #
410 # If a value, left or right, is unset (or set to any other value), no default
411 # answer is used ('y' or 'n' is explicitly required, unless 'd' or 'D'
412 # are set to any valid value, in which case this value is used instead).
413 #
414 # For example, to set 'n' as the default answer for the 'r' command, unset for
415 # trash, and 'y' for everything else: "r:n,t:u,d:y".
416 ;DefaultAnswer="o:n,r:n,t:y,R:n,d:y"
417
418 # Specify how the 'l' command creates symbolic links. Supported values:
419 # absolute = Make the target an absolute path
420 # relative = Make the target relative to the link location (like 'ln -rs')
421 # literal = Do not resolve the target at all (like 'ln -s')
422 ;LinkCreationMode=relative
423
424 # Choose the file opener for opening files with their default associated
425 # application (e.g., Ranger's rifle or xdg-open). If not specified, 'lira',
426 # Clifm's builtin opener, is used.
427 ;Opener=
428
429 # Command used to launch a terminal emulator for opening a new Clifm instance
430 # (with the 'x' command).
431 ;TerminalCmd="xterm -e"
432
433 # Set the file mode creation mask. Defaults to the value inherited from
434 # the shell (though 077 is recommended).
435 # This option is ignored in secure mode (umask is forcefully set to 077).
436 ;Umask=077
437
438 # Choose the search strategy for the quick search function. Supported values:
439 # 0 = glob-only
440 # 1 = regex-only
441 # 2 = glob-regex (default)
442 ;SearchStrategy=2
443
444 # Minimum rank for directories in the jump database. Directories with a rank
445 # below this value are removed. If set to 0, directories are retained
446 # indefinitely.
447 ;MinJumpRank=10
448
449 # Maximum total rank allowed in the jump database. When exceeded, all ranks
450 # are reduced dynamically to ensure the total falls below this limit.
451 # Entries below MinJumpRank are deleted.
452 ;MaxJumpTotalRank=100000
453
454 # Automatically remove non-existing directories from the jump database at
455 # startup. Note that this will also remove paths pointing to unmounted
456 # removable devices and remote filesystems.
457 ;PurgeJumpDB=false
458
459 # Print the list of commands executed in the current directory (the list will
460 # be cleared after changing the directory).
461 ;PrintDirCmds=false
462
463
464 #=====================================#
465 # 4. LOGS AND HISTORY #
466 #=====================================#
467
468 # Display user alerts (errors, warnings, and notices) using desktop notifications.
469 # Supported values:
470 # kitty = Use the Kitty Notifications Protocol (requires the Kitty terminal or a
471 # terminal supporting this protocol).
472 # system = Use the system notifications daemon.
473 # false = Print alerts before the prompt (no desktop notification is displayed).
474 ;DesktopNotifications=false
475
476 # Log errors and warnings.
477 ;LogMsgs=false
478 # Log commands entered in the command line.
479 ;LogCmds=false
480 # Keep only the last MaxLog lines in the log files.
481 ;MaxLog=1000
482
483 # A regular expression to filter out specific command lines from being added to
484 # the history list. Set this line to the empty string to disable history filters.
485 ;HistIgnore="^[q,Q]$|^quit$|^exit$|^ .*|^#.*|^[0-9]+$|^\.+$"
486
487 # Limit the size of the command history file to MaxHistory entries.
488 ;MaxHistory=1000
489
490 # Same as HistIgnore, but for the directory history list.
491 ;DirhistIgnore=""
492
493 # Limit the size of the directory history file to MaxDirhist entries.
494 ;MaxDirhist=100
495
496
497 #=====================================#
498 # 5. MISC #
499 #=====================================#
500
501 # Enable case-sensitive listing of files in the current directory.
502 ;CaseSensitiveList=false
503
504 # Enable case-sensitive lookups for the directory jumper function (via
505 # the 'j' command).
506 ;CaseSensitiveDirJump=false
507
508 # Enable case-sensitive filename completion.
509 ;CaseSensitivePathComp=false
510
511 # Enable case-sensitive search.
512 ;CaseSensitiveSearch=false
513
514 # Use the faster built-in magic check; fall back to libmagic if no result
515 # is found.
516 ;FastMagic=true
517
518 # When sorting files by 'version' or 'name', skip non-alphanumeric characters.
519 # For example, '__file' is sorted as 'file'.
520 # This also affects hidden files: if set to false, '.hidden' will appear
521 # before 'afile'; if set to true, it will appear after 'gfile' (unless
522 # ShowHiddenFiles is set to 'first' or 'last').
523 ;SkipNonAlnumPrefix=true
524
525 # Set a custom starting path. If not specified, it defaults to the current
526 # working directory. If set, this option overrides RestoreLastPath.
527 ;StartingPath=
528
529 # Start Clifm in the last visited directory (and in the last used
530 # workspace). This option is overriden by StartingPath (if set).
531 ;RestoreLastPath=true
532
533 # Set the readline editing mode: 0 for vi and 1 for emacs (default).
534 ;RlEditMode=1
535
536 # Set the terminal window title.
537 # Supported values:
538 # auto = Set only if the terminal supports it.
539 # true = Always (regarless of terminal support).
540 # false = Never.
541 ;TermTitle=auto
542
543 # Save the last visited directory to $XDG_CONFIG_HOME/clifm/.last, allowing
544 # it to be accessed by the corresponding shell function upon program exit.
545 # To enable this feature consult the manpage.
546 ;CdOnQuit=false
547
548 # Share the Selection Box among different profiles.
549 ;ShareSelbox=false
550
551 # Print a usage tip at startup.
552 ;Tips=true
553
554 # Just a kind welcome message at startup.
555 ;WelcomeMessage=true
556
557 # Set a custom welcome message.
558 # Use escape codes to add colors: e.g., "\e[34mWelcome!\e[0m".
559 # An ending new line character is appended automatically.
560 ;WelcomeMessageStr=""
561
562 # Print Clifm's logo screen at startup.
563 ;SplashScreen=false
564
565
566 #=====================================#
567 # 6. ALIASES #
568 #=====================================#
569
570 # Bind '?' to the interactive help plugin. Use the 'actions' command to
571 # display a list of available plugins.
572 #alias ?='ih'
573 # Bind 'b' to the directory history navigation plugin.
574 #alias b='dh'
575 # Replace the builtin deselect command (ds) with the fzfdesel plugin.
576 #alias ds='**'
577 # You can use this alias to quickly change to the current virtual directory.
578 #alias vtd='cd $CLIFM_VIRTUAL_DIR'
579 # Replace the builtin bulk rename function (br) with vidir(1).
580 #br='vidir'
581
582
583 #=====================================#
584 # 7. PROMPT COMMANDS #
585 #=====================================#
586
587 # Specify commands to be executed before each prompt is displayed. For example:
588 #promptcmd /usr/local/share/clifm/plugins/git_status.sh
589 #promptcmd date | awk '{print $1", "$2,$3", "$4}'
590
591
592 #=====================================#
593 # 8. AUTOCOMMANDS #
594 #=====================================#
595
596 # Control Clifm's settings on a per-directory basis. For more information
597 # consult the manpage.
598
599 # Remote file systems are slow: let's speed this up by enabling the light
600 # mode and disabling the file counter.
601 #autocmd /media/remotes/** lm=1,fc=0
602
603 # Just a friendly reminder when entering the ~/important directory.
604 #autocmd ~/important !printf "Keep your fingers outta here!\n" && read -n1
605
606 # Plenty of images and videos? Launch the files previewer plugin.
607 #autocmd ~/Downloads !/usr/local/share/clifm/plugins/fzfnav.sh
608
609 # Use the nord color scheme and disable hidden files in the ~/Documents
610 # directory.
611 #autocmd ~/Documents/** cs=nord,hf=0
612
613 # I want files in the third workspace to be listed in long view.
614 #autocmd @ws3 lv=1