github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-22 11:47:04 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Some work on commands

Browse Source 
The difference between keywords and "decorations" isn't important here.
This commit is contained in:
Fabian Boehm 2022-12-19 19:39:18 +01:00
parent 8284e0499f
commit 8dd89ff9dd
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc_src/commands.rst
View File

@ -20,19 +20,18 @@ Core language keywords that make up the syntax, like
- :doc:`begin <cmds/begin>` to begin a block and :doc:`end <cmds/end>` to end any block (including ifs and loops).
- :doc:`and <cmds/and>`, :doc:`or <cmds/or>` and :doc:`not <cmds/not>` to combine commands logically.
- :doc:`switch <cmds/switch>` and :doc:`case <cmds/case>` to make multiple blocks depending on the value of a variable.
- :doc:`command <cmds/command>` or :doc:`builtin <cmds/builtin>` to tell fish what sort of thing to execute
- :doc:`time <cmds/time>` to time execution
- :doc:`exec <cmds/exec>` tells fish to replace itself with a command.
Decorations
^^^^^^^^^^^
Command decorations are keywords like :doc:`command <cmds/command>` or :doc:`builtin <cmds/builtin>` to tell fish what sort of thing to execute, and :doc:`time <cmds/time>` to time its execution. :doc:`exec <cmds/exec>` tells fish to replace itself with the command.
Tools to do a task
^^^^^^^^^^^^^^^^^^
Tools
^^^^^
Builtins to do a task, like
- :doc:`cd <cmds/cd>` to change the current directory.
- :doc:`echo <cmds/echo>` or :doc:`printf <cmds/printf>` to produce output.
- :doc:`set_color <cmds/set_color>` to colorize output.
- :doc:`set <cmds/set>` to set, query or erase variables.
- :doc:`read <cmds/read>` to read input.
- :doc:`string <cmds/string>` for string manipulation.
@ -42,11 +41,11 @@ Builtins to do a task, like
- :doc:`type <cmds/type>` to find out what sort of thing (command, builtin or function) fish would call, or if it exists at all.
- :doc:`test <cmds/test>` checks conditions like if a file exists or a string is empty.
- :doc:`contains <cmds/contains>` to see if a list contains an entry.
- :doc:`abbr <cmds/abbr>` manages :ref:`abbreviations`.
- :doc:`eval <cmds/eval>` and :doc:`source <cmds/source>` to run fish code from a string or file.
- :doc:`set_color <cmds/set_color>` to colorize your output.
- :doc:`status <cmds/status>` to get shell information, like whether it's interactive or a login shell, or which file it is currently running.
- :doc:`abbr <cmds/abbr>` manages :ref:`abbreviations`.
- :doc:`bind <cmds/bind>` to change bindings.
- :doc:`complete <cmds/complete>` manages :ref:`completions <tab-completion>`.
- :doc:`commandline <cmds/commandline>` to get or change the commandline contents.
- :doc:`fish_config <cmds/fish_config>` to easily change fish's configuration, like the prompt or colorscheme.
- :doc:`random <cmds/random>` to generate random numbers or pick from a list.
@ -76,6 +75,7 @@ Some helper functions, often to give you information for use in your prompt:
- :doc:`fish_is_root_user <cmds/fish_is_root_user>` to check if the current user is an administrator user like root.
- :doc:`fish_add_path <cmds/fish_add_path>` to easily add a path to $PATH.
- :doc:`alias <cmds/alias>` to quickly define wrapper functions ("aliases").
- :doc:`fish_delta <cmds/fish_delta>` to show what you have changed from the default configuration.
Helper commands
^^^^^^^^^^^^^^^