Constant broot::conf::DEFAULT_CONF_FILE

pub const DEFAULT_CONF_FILE: &str = "###############################################################\n# This configuration file lets you\n# - define new commands\n# - change the shortcut or triggering keys of built-in verbs\n# - change the colors\n# - set default values for flags\n# - set special behaviors on specific paths\n# - and more...\n#\n# Configuration documentation is available at\n#     https://dystroy.org/broot\n#\n# This file\'s format is Hjson ( https://hjson.github.io/ ). Some\n#\u{a0}properties are commented out. To enable them, remove the `#`.\n#\n###############################################################\n{\n\n\t###############################################################\n\t# Default flags\n\t# You can set up flags you want broot to start with by\n\t# default, for example `default_flags=\"ihp\"` if you usually want\n\t# to see hidden and gitignored files and the permissions (then\n\t# if you don\'t want the hidden files you can launch `br -H`)\n\t# A popular flag is the `g` one which displays git related info.\n\t#\n\t# default_flags:\n\n\t###############################################################\n\t# Date/Time format\n\t# If you want to change the format for date/time, uncomment the\n\t# following line and change it according to\n\t# https://docs.rs/chrono/0.4.11/chrono/format/strftime/index.html\n\t#\n\t# date_time_format: %Y/%m/%d %R\n\n        ###############################################################\n        # uncomment to activate modal mode\n\t#\n\t# (you really should read https://dystroy.org/broot/vim_mode/\n\t# before as it may not suit anybody even among vim users)\n\t#\n        # modal: true\n\n\t###############################################################\n\t# Whether to mark the selected line with a triangle\n\t#\n\tshow_selection_mark: true\n\n\t###############################################################\n\t# Column order\n\t# cols_order, if specified, must be a permutation of the following\n\t# array. You should keep the name at the end as it has a variable\n\t# length.\n\t#\n\t# cols_order: [\n\t# \tmark\n\t# \tgit\n\t# \tsize\n\t# \tpermission\n\t# \tdate\n\t# \tcount\n\t# \tbranch\n\t# \tname\n\t# ]\n\n\t###############################################################\n\t# True Colors\n\t# If this parameter isn\'t set, broot tries to automatically\n\t# determine whether true colors (24 bits) are available.\n\t# As this process is unreliable, you may uncomment this setting\n\t# and set it to false or true if you notice the colors in\n\t# previewed images are too off.\n\t#\n\t# true_colors: false\n\n\t###############################################################\n\t# Icons\n\t# If you want to display icons in broot, uncomment this line\n\t# (see https://dystroy.org/broot/icons for installation and\n\t# troubleshooting)\n\t#\n\t# icon_theme: vscode\n\n\t###############################################################\n\t# Special paths\n\t# If some paths must be handled specially, uncomment (and change\n\t# this section as per the examples)\n\t#\n\t# special_paths: {\n\t# \t\"/media/slow-backup-disk\"\t\t: no-enter\n\t# \t\"/home/dys/useless\"\t\t\t: hide\n\t# \t\"/home/dys/my-link-I-want-to-explore\"\t: enter\n\t# }\n\n\n\t###############################################################\n\t# Search modes\n        #\n        # broot allows many search modes.\n        # A search mode is defined by\n        # - the way to search: fuzzy, exact, or a regular expression.\n        # - where to search: name, sub-path, or file content\n        # A search pattern may for example be \"fuzzy name\" (default),\n        # \"regex content\" or \"exact path\".\n        #\n        # The search mode is selected from its prefix. For example, if\n        # you type \"abc\", the default mode is \"fuzzy name\". If you type\n        # \"/abc\", the mode is \"regex name\". If you type \"rp/abc\", the mode\n        # is \"regex path\".\n        #\n        # This mapping may be modified. You may want to dedicate the\n        # empty prefix (the one which doesn\'t need a \'/\') to the\n        # search mode you use most often. The example below makes it\n        # easy to search on subpath rather than on the name.\n        #\n        # More information on\n        #  https://dystroy.org/broot/input/#the-filtering-pattern\n        #\n        # search_modes: {\n        #     <empty>: fuzzy path\n        #     /: regex path\n        # }\n\n\t###############################################################\n\t# Verbs and shortcuts\n\t# You can define your own commands which would be applied to\n\t# the selection.\n\t# You\'ll also find below verbs that you can customize or enable.\n\tverbs: [\n\n\t\t# Exemple 1: launching `tail -n` on the selected file (leaving broot)\n\t\t# {\n\t\t# \tname: tail_lines\n\t\t# \tinvocation: tl {lines_count}\n\t\t# \texecution: \"tail -f -n {lines_count} {file}\"\n\t\t# }\n\n\t\t# Exemple 2: creating a new file without leaving broot\n\t\t# {\n\t\t# \tname: touch\n\t\t# \tinvocation: touch {new_file}\n\t\t# \texecution: \"touch {directory}/{new_file}\"\n\t\t# \tleave_broot: false\n\t\t# }\n\n\t\t# A standard recommended command for editing files, that you\n\t\t# can customize.\n\t\t# If $EDITOR isn\'t set on your computer, you should either set it using\n\t\t#  something similar to\n\t\t#   export EDITOR=nvim\n\t\t#  or just replace it with your editor of choice in the \'execution\'\n\t\t#  pattern.\n\t\t#  If your editor is able to open a file on a specific line, use {line}\n\t\t#   so that you may jump directly at the right line from a preview.\n\t\t# Example:\n\t\t#  execution: nvim +{line} {file}\n\t\t{\n\t\t\tinvocation: edit\n\t\t\tkey: F2\n\t\t\tshortcut: e\n\t\t\texecution: \"$EDITOR +{line} {file}\"\n\t\t\tleave_broot: false\n\t\t}\n\n\t\t# A convenient shortcut to create new text files in\n\t\t# the current directory or below\n\t\t{\n\t\t\tinvocation: create {subpath}\n\t\t\texecution: \"$EDITOR {directory}/{subpath}\"\n\t\t\tleave_broot: false\n\t\t}\n\n\t\t{\n\t\t\tinvocation: git_diff\n\t\t\tshortcut: gd\n\t\t\tleave_broot: false\n\t\t\texecution: \"git difftool -y {file}\"\n\t\t}\n\n\t\t# This verb lets you launch a terminal on ctrl-T\n\t\t# (on exit you\'ll be back in broot)\n\t\t{\n\t\t\tinvocation: terminal\n\t\t\tkey: ctrl-t\n\t\t\texecution: \"$SHELL\"\n\t\t\tset_working_dir: true\n\t\t\tleave_broot: false\n\t\t}\n\n\t\t# Here\'s an example of a shortcut bringing you to your home directory\n\t\t# {\n\t\t# \tinvocation: home\n\t\t# \tkey: ctrl-home\n\t\t# \texecution: \":focus ~\"\n\t\t# }\n\n\t\t# A popular set of shortcuts for going up and down:\n\t\t#\n\t\t# {\n\t\t# \tkey: ctrl-k\n\t\t# \texecution: \":line_up\"\n\t\t# }\n\t\t# {\n\t\t# \tkey: ctrl-j\n\t\t# \texecution: \":line_down\"\n\t\t# }\n\t\t# {\n\t\t# \tkey: ctrl-u\n\t\t# \texecution: \":page_up\"\n\t\t# }\n\t\t# {\n\t\t# \tkey: ctrl-d\n\t\t# \texecution: \":page_down\"\n\t\t# }\n\n\t\t# If you develop using git, you might like to often switch\n\t\t# to the git status filter:\n\t\t# {\n\t\t# \tkey: ctrl-g\n\t\t# \texecution: \":toggle_git_status\"\n\t\t# }\n\n\t\t# You can reproduce the bindings of Norton Commander\n\t\t# on copying or moving to the other panel:\n\t\t# {\n\t\t# \tkey: F5\n\t\t# \texternal: \"cp -r {file} {other-panel-directory}\"\n\t\t# \tleave_broot: false\n\t\t# }\n\t\t# {\n\t\t# \tkey: F6\n\t\t# \texternal: \"mv {file} {other-panel-directory}\"\n\t\t# \tleave_broot: false\n\t\t# }\n\t]\n\n\t###############################################################\n\t# Skin\n\t# If you want to change the colors of broot,\n\t# uncomment the following bloc and start messing\n\t# with the various values.\n        # A skin entry value is made of two parts separated with a \'/\':\n        # The first one is the skin for the active panel.\n        # The second one, optional, is the skin for non active panels.\n\t# You may find explanations and other skins on\n\t#  https://dystroy.org/broot/skins\n\t###############################################################\n\t#\n\t# skin: {\n\t# \tdefault: gray(23) none / gray(20) none\n\t# \ttree: ansi(94) None / gray(3) None\n\t# \tfile: gray(20) None / gray(15) None\n\t# \tdirectory: ansi(208) None Bold / ansi(172) None bold\n\t# \texe: Cyan None\n\t# \tlink: Magenta None\n\t# \tpruning: gray(12) None Italic\n\t# \tperm__: gray(5) None\n\t# \tperm_r: ansi(94) None\n\t# \tperm_w: ansi(132) None\n\t# \tperm_x: ansi(65) None\n\t# \towner: ansi(138) None\n\t# \tgroup: ansi(131) None\n\t# \tcount: ansi(136) gray(3)\n\t# \tdates: ansi(66) None\n\t# \tsparse: ansi(214) None\n\t# \tcontent_extract: ansi(29) None\n\t# \tcontent_match: ansi(34) None\n\t# \tgit_branch: ansi(229) None\n\t# \tgit_insertions: ansi(28) None\n\t# \tgit_deletions: ansi(160) None\n\t# \tgit_status_current: gray(5) None\n\t# \tgit_status_modified: ansi(28) None\n\t# \tgit_status_new: ansi(94) None Bold\n\t# \tgit_status_ignored: gray(17) None\n\t# \tgit_status_conflicted: ansi(88) None\n\t# \tgit_status_other: ansi(88) None\n\t# \tselected_line: None gray(5) / None gray(4)\n\t# \tchar_match: Yellow None\n\t# \tfile_error: Red None\n\t# \tflag_label: gray(15) None\n\t# \tflag_value: ansi(208) None Bold\n\t# \tinput: White None / gray(15) gray(2)\n\t# \tstatus_error: gray(22) ansi(124)\n\t# \tstatus_job: ansi(220) gray(5)\n\t# \tstatus_normal: gray(20) gray(3) / gray(2) gray(2)\n\t# \tstatus_italic: ansi(208) gray(3) / gray(2) gray(2)\n\t# \tstatus_bold: ansi(208) gray(3) Bold / gray(2) gray(2)\n\t# \tstatus_code: ansi(229) gray(3) / gray(2) gray(2)\n\t# \tstatus_ellipsis: gray(19) gray(1) / gray(2) gray(2)\n\t# \tpurpose_normal: gray(20) gray(2)\n\t# \tpurpose_italic: ansi(178) gray(2)\n\t# \tpurpose_bold: ansi(178) gray(2) Bold\n\t# \tpurpose_ellipsis: gray(20) gray(2)\n\t# \tscrollbar_track: gray(7) None / gray(4) None\n\t# \tscrollbar_thumb: gray(22) None / gray(14) None\n\t# \thelp_paragraph: gray(20) None\n\t# \thelp_bold: ansi(208) None Bold\n\t# \thelp_italic: ansi(166) None\n\t# \thelp_code: gray(21) gray(3)\n\t# \thelp_headers: ansi(208) None\n\t# \thelp_table_border: ansi(239) None\n\t# \tpreview: gray(20) gray(1) / gray(18) gray(2)\n\t# \tpreview_line_number: gray(12) gray(3)\n\t# \tpreview_match: None ansi(29)\n\t# \thex_null: gray(11) None\n\t# \thex_ascii_graphic: gray(18) None\n\t# \thex_ascii_whitespace: ansi(143) None\n\t# \thex_ascii_other: ansi(215) None\n\t# \thex_non_ascii: ansi(167) None\n\t# }\n\n\n\t###############################################################\n\t# File Extension Colors\n\t#\n\t# uncomment and modify the next section if you want to color\n\t# file name depending on their extension\n\t#\n\t# ext_colors: {\n\t# \tpng: rgb(255, 128, 75)\n\t# \trs: yellow\n\t# }\n\n\n\t###############################################################\n\t# Max Panels Count\n        #\n\t# Change this if you sometimes want to have more than 2 panels\n        # open\n        # max_panels_count: 2\n}\n";

the content of the conf.hjson file broot creates when there’s none.

It features some default configuration and many sections the user can uncomment then edit.