diff options
| -rw-r--r-- | Fish-Shell.sublime-workspace | 850 | ||||
| -rw-r--r-- | doc_src/FORMATTING.md | 86 | ||||
| -rw-r--r-- | doc_src/faq.hdr | 24 | ||||
| -rw-r--r-- | doc_src/user_doc.css | 6 | ||||
| -rw-r--r-- | lexicon_filter.in | 3 |
5 files changed, 216 insertions, 753 deletions
diff --git a/Fish-Shell.sublime-workspace b/Fish-Shell.sublime-workspace index 8196e2e2..d12ed5d4 100644 --- a/Fish-Shell.sublime-workspace +++ b/Fish-Shell.sublime-workspace @@ -4,6 +4,18 @@ "selected_items": [ [ + "m", + "margin-bottom" + ], + [ + "ma", + "margin-left" + ], + [ + "a-z", + "a-zA-Z_" + ], + [ "font", "font-style" ], @@ -72,10 +84,6 @@ "background-image" ], [ - "ma", - "margin" - ], - [ "marg", "margin-left" ], @@ -196,10 +204,6 @@ "text-align" ], [ - "m", - "margin-left" - ], - [ "_", "_Interface" ], @@ -510,71 +514,11 @@ [ "Block", "blockOffset" - ], - [ - "top", - "topOffest" ] ] }, "buffers": [ - { - "file": "doc_src/FORMATTING.md", - "settings": - { - "buffer_size": 6126, - "line_ending": "Unix" - } - }, - { - "file": "Makefile.in", - "settings": - { - "buffer_size": 34459, - "line_ending": "Unix" - } - }, - { - "file": "Doxyfile.help", - "settings": - { - "buffer_size": 102690, - "line_ending": "Unix" - } - }, - { - "file": "Doxyfile.user", - "settings": - { - "buffer_size": 103736, - "line_ending": "Unix" - } - }, - { - "file": "Doxyfile", - "settings": - { - "buffer_size": 103115, - "line_ending": "Unix" - } - }, - { - "file": "doc_src/tutorial.hdr", - "settings": - { - "buffer_size": 17999, - "line_ending": "Unix" - } - }, - { - "file": "doc_src/faq.hdr", - "settings": - { - "buffer_size": 10388, - "line_ending": "Unix" - } - } ], "build_system": "Make Fish-Shell", "command_palette": @@ -746,92 +690,102 @@ "expanded_folders": [ "/Users/Mark/Projects/OpenSource/fish-shell", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src" + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src", + "/Users/Mark/Projects/OpenSource/fish-shell/share/completions" ], "file_history": [ + "/Users/Mark/Projects/OpenSource/fish-shell/lexicon.log", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/faq.hdr", + "/Users/Mark/Projects/OpenSource/fish-shell/lexicon_filter.in", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish_prompt.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/FORMATTING.md", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/user_doc.css", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/user_doc_syntax.css", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/design.hdr", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/.editorconfig", + "/Users/Mark/Projects/OpenSource/fish-shell/exec.cpp", + "/Users/Mark/Projects/OpenSource/fish-shell/expand.cpp", + "/Users/Mark/Projects/OpenSource/fish-shell/share/completions/fossil.fish", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/tutorial.hdr", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/index.hdr.in", + "/Users/Mark/Projects/OpenSource/fish-shell/Makefile.in", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/command.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/contains.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/read.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/type.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/ulimit.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/complete.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/commands.hdr.in", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/count.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/echo.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/Doxyfile.user", + "/Users/Mark/Projects/OpenSource/fish-shell/Doxyfile.help", + "/Users/Mark/Projects/OpenSource/fish-shell/Doxyfile", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/trap.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/status.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/set_color.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/else.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/jobs.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/mimedb.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish_indent.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/functions.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/bind.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/.git/MERGE_MSG", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/psub.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/nextd.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/set.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/lexicon.txt", + "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/history.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc/latex/tutorial.tex", "/Users/Mark/Projects/OpenSource/fish-shell/doc/html/commands.html", "/Users/Mark/Projects/OpenSource/fish-shell/doc/latex/commands.tex", - "/Users/Mark/Projects/OpenSource/fish-shell/Doxyfile", - "/Users/Mark/Projects/OpenSource/fish-shell/Doxyfile.help", - "/Users/Mark/Projects/OpenSource/fish-shell/Doxyfile.user", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/user_doc.css", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/design.hdr", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/alias.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/echo.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/open.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/while.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/vared.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/and.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/begin.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/bg.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/bind.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/block.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/break.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/breakpoint.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/builtin.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/case.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/cd.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/command.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/commandline.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/complete.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/contains.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/continue.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/count.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/dirh.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/dirs.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/else.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/emit.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/end.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/eval.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/exec.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/exit.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/faq.hdr", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fg.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish_config.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish_indent.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish_prompt.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish_right_prompt.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/for.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/funced.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/funcsave.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/function.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/functions.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/help.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/history.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/if.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/index.hdr.in", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/isatty.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/jobs.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/license.hdr", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/math.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/mimedb.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/nextd.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/not.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/or.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/popd.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/prevd.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/psub.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/pushd.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/random.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/read.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/return.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/set.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/set_color.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/source.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/status.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/switch.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/test.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/trap.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/tutorial.hdr", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/type.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/ulimit.txt", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/umask.txt", - "/Users/Mark/Projects/OpenSource/fish-shell/Makefile.in", - "/Users/Mark/Projects/OpenSource/fish-shell/lexicon_filter.in", - "/Users/Mark/Projects/OpenSource/fish-shell/lexicon.log", "/usr/local/Library/Formula/fish.rb", "/Users/Mark/Projects/OpenSource/fish-shell/doc.h", "/Users/Mark/Projects/OpenSource/fish-shell/1", @@ -843,9 +797,7 @@ "/tmp/fish_funced_50461_8117.fish", "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_16914_12938.fish", "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_16914_8747.fish", - "/Users/Mark/Projects/OpenSource/fish-shell/lexicon.txt", "/Users/Mark/Projects/OpenSource/fish-shell/debug-lexicon.log", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/commands.hdr.in", "/Users/Mark/Projects/OpenSource/fish-shell/config.h.in~", "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish_lexicon_filter.in", "/Users/Mark/Projects/OpenSource/fish-shell/README.md", @@ -870,14 +822,7 @@ "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_7461.fish", "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_4834.fish", "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_2485.fish", - "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_29584.fish", - "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_3237.fish", - "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_25359.fish", - "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_21748.fish", - "/Users/Mark/Projects/OpenSource/fish-shell/share/man/man1/alias.1.tmp", - "/Users/Mark/Projects/OpenSource/fish-shell/doc_src/fish_lexicon_filter", - "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_17427.fish", - "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_11508.fish" + "/var/folders/34/z1p9ktbj5971t9cp9vlptt40000101/T/fish_funced_29780_29584.fish" ], "find": { @@ -934,6 +879,64 @@ "case_sensitive": true, "find_history": [ + "bksl", + "set_color", + "bksl", + "set_color", + "virago", + "user_doc", + "Additional stying can be applied using a declaration ", + ">>>>>>>", + "split_output", + ">>>>>>>", + "fsfo", + "shells", + ".logo", + "\\fish", + "-h", + "emit", + "foo.t", + "\\[else", + "cmnd", + "xbin", + "sbin", + "cmnd", + "xcmd", + "cmnd", + "<tt>([A-z .=~-]+)</tt>", + "\\\\c ([A-z.~-]+)", + "<code>([A-z .=~-]+)</code>", + "\\\\c ([A-z.~]+)", + "<tt>([A-z .=~-]+)</tt>", + "<tt>([A-z .~-]+)</tt>", + "\\\\c ([A-z.~]+)", + "\\\\c ([A-z]+)", + "\\c ", + "\\c \\([a-z]*\\)", + ">>>>>>>", + "\\c ", + ">>>>>>>", + "bksl", + "_=_", + "Special case for", + "@args\\{\\\\", + "@args{\\\\\\", + "@args{\\\\", + "__", + "sleep", + "s//", + "s/", + "and", + ".bak", + "basename", + "grep", + ".bak", + ".txt", + "status", + "optr", + "entities", + "@optr", + "src", "float", "!", "ref", @@ -1003,65 +1006,7 @@ "\\--", "\\\\--", "echo", - "SIGCHLD", - "execute", - "signal", - "reader_run_command", - "preexec", - "preexec_invoke_exec", - "preexec_interactive_mode", - "alias \\\\\\- ([^ ]*) ", - "roff", - " Synopsis\\n\n\\\\fish", - "Synopsis\\n\n\\\\fish", - "Synopsis\\n", - "w de", - "grep", - "[ ]*", - "debug", - "fish_lexicon_filter", - "FILTER", - "INPUT", - "I", - " *", - "sglq", - "dblq", - "asis", - "#Output", - "#OUtput", - ".cli-dark ", - "width", - "optimizeLegibility", - "F", - "Background", - "/f", - "#f", - "--is", - "-login", - "$f", - "#f", - "\\\\fish\\{syn\\}", - "\\\\fish{syn}", - "\\fish{syn}", - "#f", - "[", - "etc/shells", - "curs", - "Alt+Up", - "@key", - "date", - "tutorial_nav", - "fsfo", - "fsnm", - "HELP_SRC", - "HTML_SRC", - ".in", - "user_doc", - "Synopsis\n<pre>([^`]*)<pre>", - "Synopsis\n`([^`]*)`", - "Synopsis\n `([^`]*)`", - "Synopsis\n`", - "grep" + "SIGCHLD" ], "highlight": true, "in_selection": false, @@ -1069,6 +1014,16 @@ "regex": true, "replace_history": [ + "\\fish{cli-dark}", + "xcmd", + "cmnd", + "bltn", + "xbln", + "bltn", + "`$1`", + "`", + "one-line", + "or", "\n- ", "sglq", "$1@xcmd\\n$2/", @@ -1186,17 +1141,7 @@ "`", "`$1`", "$2`$1`$2", - "`$1`", - "`", - "</code>'", - "'<code>", - "`'", - "'`", - "<code>fish</code>", - "- ", - "<h3>$1</h3>", - " -# ", - " -#" + "`$1`" ], "reverse": false, "show_context": true, @@ -1207,546 +1152,8 @@ "groups": [ { - "selected": 4, "sheets": [ - { - "buffer": 0, - "file": "doc_src/FORMATTING.md", - "semi_transient": false, - "settings": - { - "buffer_size": 6126, - "regions": - { - }, - "selection": - [ - [ - 5237, - 5237 - ] - ], - "settings": - { - "BracketHighlighterBusy": false, - "bh_regions": - [ - "bh_unmatched", - "bh_unmatched_center", - "bh_unmatched_open", - "bh_unmatched_close", - "bh_curly", - "bh_curly_center", - "bh_curly_open", - "bh_curly_close", - "bh_default", - "bh_default_center", - "bh_default_open", - "bh_default_close", - "bh_round", - "bh_round_center", - "bh_round_open", - "bh_round_close", - "bh_square", - "bh_square_center", - "bh_square_open", - "bh_square_close", - "bh_angle", - "bh_angle_center", - "bh_angle_open", - "bh_angle_close", - "bh_single_quote", - "bh_single_quote_center", - "bh_single_quote_open", - "bh_single_quote_close", - "bh_double_quote", - "bh_double_quote_center", - "bh_double_quote_open", - "bh_double_quote_close", - "bh_tag", - "bh_tag_center", - "bh_tag_open", - "bh_tag_close", - "bh_regex", - "bh_regex_center", - "bh_regex_open", - "bh_regex_close", - "bh_c_define", - "bh_c_define_center", - "bh_c_define_open", - "bh_c_define_close" - ], - "syntax": "Packages/MarkdownEditing/Markdown.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 1692.0, - "zoom_level": 1.0 - }, - "stack_index": 2, - "type": "text" - }, - { - "buffer": 1, - "file": "Makefile.in", - "semi_transient": false, - "settings": - { - "buffer_size": 34459, - "regions": - { - }, - "selection": - [ - [ - 7138, - 7138 - ] - ], - "settings": - { - "BracketHighlighterBusy": false, - "bh_regions": - [ - "bh_unmatched", - "bh_unmatched_center", - "bh_unmatched_open", - "bh_unmatched_close", - "bh_curly", - "bh_curly_center", - "bh_curly_open", - "bh_curly_close", - "bh_default", - "bh_default_center", - "bh_default_open", - "bh_default_close", - "bh_round", - "bh_round_center", - "bh_round_open", - "bh_round_close", - "bh_square", - "bh_square_center", - "bh_square_open", - "bh_square_close", - "bh_angle", - "bh_angle_center", - "bh_angle_open", - "bh_angle_close", - "bh_single_quote", - "bh_single_quote_center", - "bh_single_quote_open", - "bh_single_quote_close", - "bh_double_quote", - "bh_double_quote_center", - "bh_double_quote_open", - "bh_double_quote_close", - "bh_tag", - "bh_tag_center", - "bh_tag_open", - "bh_tag_close", - "bh_regex", - "bh_regex_center", - "bh_regex_open", - "bh_regex_close", - "bh_c_define", - "bh_c_define_center", - "bh_c_define_open", - "bh_c_define_close" - ], - "syntax": "Packages/Text/Plain text.tmLanguage", - "translate_tabs_to_spaces": false - }, - "translation.x": 0.0, - "translation.y": 3682.0, - "zoom_level": 1.0 - }, - "stack_index": 4, - "type": "text" - }, - { - "buffer": 2, - "file": "Doxyfile.help", - "semi_transient": false, - "settings": - { - "buffer_size": 102690, - "regions": - { - }, - "selection": - [ - [ - 10175, - 10175 - ] - ], - "settings": - { - "BracketHighlighterBusy": false, - "bh_regions": - [ - "bh_unmatched", - "bh_unmatched_center", - "bh_unmatched_open", - "bh_unmatched_close", - "bh_curly", - "bh_curly_center", - "bh_curly_open", - "bh_curly_close", - "bh_default", - "bh_default_center", - "bh_default_open", - "bh_default_close", - "bh_round", - "bh_round_center", - "bh_round_open", - "bh_round_close", - "bh_square", - "bh_square_center", - "bh_square_open", - "bh_square_close", - "bh_angle", - "bh_angle_center", - "bh_angle_open", - "bh_angle_close", - "bh_single_quote", - "bh_single_quote_center", - "bh_single_quote_open", - "bh_single_quote_close", - "bh_double_quote", - "bh_double_quote_center", - "bh_double_quote_open", - "bh_double_quote_close", - "bh_tag", - "bh_tag_center", - "bh_tag_open", - "bh_tag_close", - "bh_regex", - "bh_regex_center", - "bh_regex_open", - "bh_regex_close", - "bh_c_define", - "bh_c_define_center", - "bh_c_define_open", - "bh_c_define_close" - ], - "syntax": "Packages/Text/Plain text.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 3051.0, - "zoom_level": 1.0 - }, - "stack_index": 5, - "type": "text" - }, - { - "buffer": 3, - "file": "Doxyfile.user", - "semi_transient": false, - "settings": - { - "buffer_size": 103736, - "regions": - { - }, - "selection": - [ - [ - 10080, - 10080 - ] - ], - "settings": - { - "BracketHighlighterBusy": false, - "bh_regions": - [ - "bh_unmatched", - "bh_unmatched_center", - "bh_unmatched_open", - "bh_unmatched_close", - "bh_curly", - "bh_curly_center", - "bh_curly_open", - "bh_curly_close", - "bh_default", - "bh_default_center", - "bh_default_open", - "bh_default_close", - "bh_round", - "bh_round_center", - "bh_round_open", - "bh_round_close", - "bh_square", - "bh_square_center", - "bh_square_open", - "bh_square_close", - "bh_angle", - "bh_angle_center", - "bh_angle_open", - "bh_angle_close", - "bh_single_quote", - "bh_single_quote_center", - "bh_single_quote_open", - "bh_single_quote_close", - "bh_double_quote", - "bh_double_quote_center", - "bh_double_quote_open", - "bh_double_quote_close", - "bh_tag", - "bh_tag_center", - "bh_tag_open", - "bh_tag_close", - "bh_regex", - "bh_regex_center", - "bh_regex_open", - "bh_regex_close", - "bh_c_define", - "bh_c_define_center", - "bh_c_define_open", - "bh_c_define_close" - ], - "syntax": "Packages/Text/Plain text.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 3096.0, - "zoom_level": 1.0 - }, - "stack_index": 3, - "type": "text" - }, - { - "buffer": 4, - "file": "Doxyfile", - "semi_transient": false, - "settings": - { - "buffer_size": 103115, - "regions": - { - }, - "selection": - [ - [ - 10419, - 10419 - ] - ], - "settings": - { - "BracketHighlighterBusy": false, - "bh_regions": - [ - "bh_unmatched", - "bh_unmatched_center", - "bh_unmatched_open", - "bh_unmatched_close", - "bh_curly", - "bh_curly_center", - "bh_curly_open", - "bh_curly_close", - "bh_default", - "bh_default_center", - "bh_default_open", - "bh_default_close", - "bh_round", - "bh_round_center", - "bh_round_open", - "bh_round_close", - "bh_square", - "bh_square_center", - "bh_square_open", - "bh_square_close", - "bh_angle", - "bh_angle_center", - "bh_angle_open", - "bh_angle_close", - "bh_single_quote", - "bh_single_quote_center", - "bh_single_quote_open", - "bh_single_quote_close", - "bh_double_quote", - "bh_double_quote_center", - "bh_double_quote_open", - "bh_double_quote_close", - "bh_tag", - "bh_tag_center", - "bh_tag_open", - "bh_tag_close", - "bh_regex", - "bh_regex_center", - "bh_regex_open", - "bh_regex_close", - "bh_c_define", - "bh_c_define_center", - "bh_c_define_open", - "bh_c_define_close" - ], - "syntax": "Packages/Text/Plain text.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 3307.0, - "zoom_level": 1.0 - }, - "stack_index": 0, - "type": "text" - }, - { - "buffer": 5, - "file": "doc_src/tutorial.hdr", - "semi_transient": false, - "settings": - { - "buffer_size": 17999, - "regions": - { - }, - "selection": - [ - [ - 6360, - 6360 - ] - ], - "settings": - { - "BracketHighlighterBusy": false, - "bh_regions": - [ - "bh_unmatched", - "bh_unmatched_center", - "bh_unmatched_open", - "bh_unmatched_close", - "bh_curly", - "bh_curly_center", - "bh_curly_open", - "bh_curly_close", - "bh_default", - "bh_default_center", - "bh_default_open", - "bh_default_close", - "bh_round", - "bh_round_center", - "bh_round_open", - "bh_round_close", - "bh_square", - "bh_square_center", - "bh_square_open", - "bh_square_close", - "bh_angle", - "bh_angle_center", - "bh_angle_open", - "bh_angle_close", - "bh_single_quote", - "bh_single_quote_center", - "bh_single_quote_open", - "bh_single_quote_close", - "bh_double_quote", - "bh_double_quote_center", - "bh_double_quote_open", - "bh_double_quote_close", - "bh_tag", - "bh_tag_center", - "bh_tag_open", - "bh_tag_close", - "bh_regex", - "bh_regex_center", - "bh_regex_open", - "bh_regex_close", - "bh_c_define", - "bh_c_define_center", - "bh_c_define_open", - "bh_c_define_close" - ], - "syntax": "Packages/Text/Plain text.tmLanguage", - "tab_size": 2, - "translate_tabs_to_spaces": true - }, - "translation.x": 0.0, - "translation.y": 2511.0, - "zoom_level": 1.0 - }, - "stack_index": 1, - "type": "text" - }, - { - "buffer": 6, - "file": "doc_src/faq.hdr", - "semi_transient": false, - "settings": - { - "buffer_size": 10388, - "regions": - { - }, - "selection": - [ - [ - 2690, - 2668 - ] - ], - "settings": - { - "BracketHighlighterBusy": false, - "bh_regions": - [ - "bh_unmatched", - "bh_unmatched_center", - "bh_unmatched_open", - "bh_unmatched_close", - "bh_curly", - "bh_curly_center", - "bh_curly_open", - "bh_curly_close", - "bh_default", - "bh_default_center", - "bh_default_open", - "bh_default_close", - "bh_round", - "bh_round_center", - "bh_round_open", - "bh_round_close", - "bh_square", - "bh_square_center", - "bh_square_open", - "bh_square_close", - "bh_angle", - "bh_angle_center", - "bh_angle_open", - "bh_angle_close", - "bh_single_quote", - "bh_single_quote_center", - "bh_single_quote_open", - "bh_single_quote_close", - "bh_double_quote", - "bh_double_quote_center", - "bh_double_quote_open", - "bh_double_quote_close", - "bh_tag", - "bh_tag_center", - "bh_tag_open", - "bh_tag_close", - "bh_regex", - "bh_regex_center", - "bh_regex_open", - "bh_regex_close", - "bh_c_define", - "bh_c_define_center", - "bh_c_define_open", - "bh_c_define_close" - ], - "syntax": "Packages/Text/Plain text.tmLanguage", - "tab_size": 2, - "translate_tabs_to_spaces": true - }, - "translation.x": 0.0, - "translation.y": 742.0, - "zoom_level": 1.0 - }, - "stack_index": 6, - "type": "text" - } ] } ], @@ -1847,6 +1254,7 @@ ], "width": 985.0 }, + "selected_group": 0, "settings": { }, diff --git a/doc_src/FORMATTING.md b/doc_src/FORMATTING.md index 20fb35eb..17acd8c1 100644 --- a/doc_src/FORMATTING.md +++ b/doc_src/FORMATTING.md @@ -1,14 +1,14 @@ # Formatting guide for fish docs -The fish documentation has been updated to support Doxygen 1.8+, and while the main benefit of this change is extensive markdown support, the addition of a fish lexicon and syntax filter, combined with semantic markup rules allows for automatic formatting enhancements across the HTML user_docs, the developer docs and the man pages. +The fish documentation has been updated to support Doxygen 1.8+, and while the main benefit of this change is extensive Markdown support, the addition of a fish lexicon and syntax filter, combined with semantic markup rules allows for automatic formatting enhancements across the HTML user_docs, the developer docs and the man pages. -Initially my motivation was to fix a problem with long options (see [Issue #1557](https://github.com/fish-shell/fish-shell/issues/1557) on GitHub), but as I worked on fixing the issue I realised there was an opportunity to simplify, reinforce and clarify the current documentation, hopefully making further contribution easier and cleaner, while allowing the documentation examples to presented more clearly with less author effort. +Initially my motivation was to fix a problem with long options ([Issue #1557](https://github.com/fish-shell/fish-shell/issues/1557) on GitHub), but as I worked on fixing the issue I realised there was an opportunity to simplify, reinforce and clarify the current documentation, hopefully making further contribution easier and cleaner, while allowing the documentation examples to presented more clearly with less author effort. While the documentation is pretty robust to variations in the documentation source, adherence to the following style guide will help keep the already excellent documention in good shape moving forward. ## Line breaks and wrapping -Contrary to the rest of the fish source code, the documentation greatly benefits from the use of long lines and soft wrapping. It allows paragraphs to be treated as complete blocks by Doxygen, means that the semantic filter can see complete lines when deciding on how to apply syntax highlighting, and means that man pages will consistently wrap to the width of the users console in more advanced pagers, such as 'most'. +Contrary to the rest of the fish source code, the documentation greatly benefits from the use of long lines and soft wrapping. It allows paragraphs to be treated as complete blocks by Doxygen, means that the semantic filter can see complete lines when deciding on how to apply syntax highlighting, and means that man pages will consistently wrap to the width of the users console in advanced pagers, such as 'most'. ## Doxygen special commands and aliases @@ -68,8 +68,73 @@ And a simple HTML version for the developer docs (`make doc`) and the LATEX/PDF `echo hello world` +### Fonts + +In older browsers, it was easy to set the fonts used for the three basic type styles (serif, sans-serif and monospace). Modern browsers have removed these options in their respective quests for simplification, assuming the content author will provide suitable styles for the content in the site's CSS, or the end user will provide overriding styles manually. Doxygen's default styling is very simple and most users just accept this default. + +I've tried to use a sensible set of fonts in the documentation's CSS based on 'good' terminal fonts and as a result the firt preference font used throughout the documentation is '[DejaVu](http://dejavu-fonts.org)'. The rationale behaind this is that while DejaVu is getting a little long in the tooth, it still provides the most complete support across serif, sans-serif and monospace styles, has the widest support for extended Unicode characters and has a free, permissive licenses (though it's still incompatible with GPLv2, though arguably less so than the SIL Open Font license, though this is a moot point when using it solely in the docs). + +#### Fonts inside \\fish blocks and \`backticks\` + +As the point of these contructs is to make fish's syntax clearer to the user, it makes sense to mimic what the user will see in the console, therefore any content is formatted using the monospaced style, specifically monospaced fonts are chosen in the following order: + +1. __DejaVu Sans Mono__: Explained above. [[↓](http://dejavu-fonts.org)] +2. __Source Code Pro__: Monospaced code font, part of Adobe's free Edge Web Fonts. [[↓](https://edgewebfonts.adobe.com)] +3. __Menlo__: Apple supplied variant of DejaVu. +4. __Ubuntu Mono__: Ubuntu Linux's default monospaced font. [[↓](http://font.ubuntu.com)] +5. __Consolas__: Modern Microsoft supplied console font. +6. __Monaco__: Apple supplied console font since 1984! +7. __Lucida Console__: Generic mono terminal font, standard in many OS's and distros. +8. __monospace__: catchall style. Chooses default monospaced font, often Courier. +9. __fixed__: as above, more often used on mobile devices. + +#### General Fonts + +#### Other sources: + +- [Font Squirrel](http://www.fontsquirrel.com): Good source of open source font packages. + ### Choosing a CLI style: using a \\fish{style} block +By default, when output as HTML, a \\fish block uses syntax colouring suited to the style of the documentation rather than trying to mimic the terminal. The block has a light, bordered background and a colour scheme that 'suggests' what the user would see in a console. + +Additional stying can be applied adding a style declaration: + + \fish{additional_style [another_style...]} + ... + \endfish + +This will translate to classes applied to the `<div>` tag, like so: + + <div class="fish additional_style another_style"> + ... + </div> + +The various classes are defined in `doc_src/user_doc.css` and new style can be simply added + +The documentation currently defines a couple of additional styles: + +- __cli-dark__: Used in the _tutorial_ and _FAQ_ to simulate a dark background terminal, with fish's default colours (slightly tweaked for legibility in the browser). + +- __synopsis__: A simple colour theme helpful for displaying the logical 'summary' of a command's syntax, options and structure. + +## Markdown + + + +### Backticks + + +### Lists + +### Synopsis rules + + + +## Special cases + +### Prompts and cursors + ### Keyboard shortcuts: @key{} and @cursor_key{} Graphical keyboard shortcuts can be defined using the following special commands. These allow for the different text requirements across the html and man pages. The HTML uses CSS to create a keyboard style, whereas the man page would display the key as text. @@ -97,17 +162,4 @@ Some useful Unicode/HTML5 entities: - Mac option: `⌥` - Mac command: `⌘` -## Markdown - - - -### Backticks - - -### Lists - -### Synopsis rules - -### Prompts and cursor - -#### Author: Mark Griffiths [@GitHub](https://github.com/MarkGriffiths)
\ No newline at end of file +#### Author: Mark Griffiths [@GitHub](https://github.com/MarkGriffiths) diff --git a/doc_src/faq.hdr b/doc_src/faq.hdr index 22c323d3..75cbcd9a 100644 --- a/doc_src/faq.hdr +++ b/doc_src/faq.hdr @@ -46,7 +46,7 @@ set -e key Edit the file `~/.config/fish/config.fish`, creating it if it does not exist (Note the leading period). - +<hr> \section faq-prompt How do I set my prompt? The prompt is the output of the `fish_prompt` function. Put it in `~/.config/fish/functions/fish_prompt.fish`. For example, a simple prompt is: @@ -67,7 +67,7 @@ You can also use the Web configuration tool, <a href="commands.html#fish_config" Type some part of the command, and then hit the @cursor_key{↑,up} or @cursor_key{↓,down} arrow keys to navigate through history matches. - +<hr> \section faq-subcommand How do I run a subcommand? The backtick doesn't work! `fish` uses parentheses for subcommands. For example: @@ -83,7 +83,7 @@ end Use the `$status` variable. This replaces the `$?` variable used in some other shells. - +<hr> \section faq-single-env How do I set an environment variable for just one command? <i>`SOME_VAR=1 command` produces an error: `Unknown command "SOME_VAR=1"`.</i> @@ -106,12 +106,12 @@ end Use the web configuration tool, <a href="commands.html#fish_config">`fish_config`</a>, or alter the <a href="index.html#variables-color">`fish_color` family of environment variables</a>. - +<hr> \section faq-update-manpage-completions How do I update man page completions? Use the <a href="commands.html#fish_update_completions">`fish_update_completions`</a> command. - +<hr> \section faq-cwd-symlink Why does cd, $PWD and and various fish commands always resolve symlinked directories to their canonical path? <i>For example if `~/images` is a symlink to `~/Documents/Images`, if I write '`cd images`', my prompt will say `~/D/Images`, not `~/images`.</i> @@ -122,17 +122,17 @@ Writing `cd images; ls ..` given the above directory structure would list the co Another related issue is that many programs that operate on recursive directory trees, like the find command, silently ignore symlinked directories. For example, ```find $PWD -name '*.txt'``` silently fails in shells that don't resolve symlinked paths. - +<hr> \section faq-cd-implicit I accidentally entered a directory path and fish changed directory. What happened? If fish is unable to locate a command with a given name, and it starts with '`.`', '`/`' or '`~`', fish will test if a directory of that name exists. If it does, it is implicitly assumed that you want to change working directory. For example, the fastest way to switch to your home directory is to simply press `~` and enter. - +<hr> \section faq-open The open command doesn't work. The `open` command uses the MIME type database and the `.desktop` files used by Gnome and KDE to identify filetypes and default actions. If at least one of these environments is installed, but the open command is not working, this probably means that the relevant files are installed in a non-standard location. Consider <a href="index.html#more-help">asking for more help</a>. - +<hr> \section faq-default How do I make fish my default shell? If you installed fish manually (e.g. by compiling it, not by using a package manager), you first need to add fish to the list of shells by executing the following command (assuming you installed fish in /usr/local) as root: @@ -153,7 +153,7 @@ You may need to adjust the above path to e.g. `/usr/bin/fish`. Use the command ` Unfortunately, there is no way to make the changes take effect at once. You will need to log out and back in again. - +<hr> \section faq-titlebar I'm seeing weird output before each prompt when using screen. What's wrong? Quick answer: @@ -172,7 +172,7 @@ Fish is trying to set the titlebar message of your terminal. While screen itself Note that fish has a default titlebar message, which will be used if the fish_title function is undefined. So simply unsetting the fish_title function will not work. - +<hr> \section faq-greeting How do I change the greeting message? Change the value of the variable `fish_greeting` or create a `fish_greeting` function. For example, to remove the greeting use: @@ -200,7 +200,7 @@ Fish history recall is very simple yet effective: See <a href='index.html#editor'>documentation</a> for more details about line editing in fish. - +<hr> \section faq-uninstalling Uninstalling fish Should you wish to uninstall fish, first ensure fish is not set as your shell. Run `chsh -s /bin/bash` if you are not sure. @@ -218,4 +218,4 @@ rm -f fish mimedb fishd fish_indent </div> \endhtmlonly -*/
\ No newline at end of file +*/ diff --git a/doc_src/user_doc.css b/doc_src/user_doc.css index 0673f417..a6bf54ef 100644 --- a/doc_src/user_doc.css +++ b/doc_src/user_doc.css @@ -43,7 +43,7 @@ body { bottom: 0; overflow-y: scroll; -webkit-overflow-scrolling: touch; /* necessary for momentum scrolling */ - font: 400 1.3rem/2.1rem "DejaVuSans", Roboto, "Helvetica Neue", Helvetica, Arial, sans-serif; + font: 400 1.3rem/2.1rem "DejaVuSans", Roboto, Verdana, "Helvetica Neue", Helvetica, Arial, sans-serif; } .fish_left_bar { width: 25rem; @@ -103,7 +103,7 @@ a { color: #3d5cb3; } p { margin: 1rem 0; } h1, h2, h3, h4, h5, h6 { color: #1f2d53; - font-family: Roboto, "DejaVuSansCondensed-Bold", "DejaVuSans-Bold", Verdana, sans-serif; + font-family: "DejaVuSansCondensed-Bold", Roboto, "DejaVuSans-Bold", Verdana, sans-serif; } h1 { margin: 1.6rem 0 1rem 0; @@ -145,7 +145,7 @@ h3 { box-shadow: 0 1px 2px #ddd; } tt, code, pre, .fish { - font-family: "DejaVu Sans Mono", Menlo, Monaco, "Source Code Pro", "Ubuntu Mono", "Consolas", "Lucida Console", monospace, fixed; + font-family: "DejaVu Sans Mono", "Source Code Pro", Menlo, "Ubuntu Mono", "Consolas", Monaco, "Lucida Console", monospace, fixed; font-weight: 500; text-shadow: 0 0 0 rgba(0,0,0,0.2); } diff --git a/lexicon_filter.in b/lexicon_filter.in index 02ded839..c854d21a 100644 --- a/lexicon_filter.in +++ b/lexicon_filter.in @@ -216,6 +216,9 @@ s/___\(.\)/\\\ <@curs{\1}\ / #. +# Trailing Backslash +s/ \\$/ @bksl{ }/ +#. # Paths /\n<@dblq[^}]*[~/]/b protect /\n<@sglq[^}]*[~/]/b protect |