github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-23 20:04:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
d803ebbff9
fish-shell/doc_src/commands.rst

98 lines
4.9 KiB
ReStructuredText
Raw Normal View History

docs: Remove explicit .html links Instead, we link to rst labels, which could also work in non-html output, or if the section ever moves elsewhere. See #5696. [ci skip]
2019-04-30 19:10:19 +08:00
.. _commands:
Break out commands into its own file
2019-02-11 10:01:37 +08:00
Commands
============
docs: Hand-write a list of short descriptions in commands This is more readable than the full list, especially for the important things.
2021-10-23 22:46:15 +08:00
This is a list of all the commands fish ships with.
Broadly speaking, these fall into a few categories:
Keywords
^^^^^^^^
Core language keywords that make up the syntax, like
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- :doc:`if <cmds/if>` for conditions.
- :doc:`for <cmds/for>` and :doc:`while <cmds/while>` for loops.
- :doc:`break <cmds/break>` and :doc:`continue <cmds/continue>` to control loops.
- :doc:`function <cmds/function>` to define functions.
- :doc:`return <cmds/return>` to return a status from a function.
- :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.
docs: Some work on commands The difference between keywords and "decorations" isn't important here.
2022-12-20 02:39:18 +08:00
- :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.
docs: Hand-write a list of short descriptions in commands This is more readable than the full list, especially for the important things.
2021-10-23 22:46:15 +08:00
docs: Some work on commands The difference between keywords and "decorations" isn't important here.
2022-12-20 02:39:18 +08:00
Tools
^^^^^
docs: Hand-write a list of short descriptions in commands This is more readable than the full list, especially for the important things.
2021-10-23 22:46:15 +08:00
Builtins to do a task, like
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- :doc:`cd <cmds/cd>` to change the current directory.
- :doc:`echo <cmds/echo>` or :doc:`printf <cmds/printf>` to produce output.
docs: Some work on commands The difference between keywords and "decorations" isn't important here.
2022-12-20 02:39:18 +08:00
- :doc:`set_color <cmds/set_color>` to colorize output.
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- :doc:`set <cmds/set>` to set, query or erase variables.
- :doc:`read <cmds/read>` to read input.
- :doc:`string <cmds/string>` for string manipulation.
doc: Link path in commands
2023-04-30 01:58:41 +08:00
- :doc:`path <cmds/path>` for filtering paths and handling their components.
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- :doc:`math <cmds/math>` does arithmetic.
- :doc:`argparse <cmds/argparse>` to make arguments easier to handle.
- :doc:`count <cmds/count>` to count arguments.
- :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:`eval <cmds/eval>` and :doc:`source <cmds/source>` to run fish code from a string or file.
- :doc:`status <cmds/status>` to get shell information, like whether it's interactive or a login shell, or which file it is currently running.
docs: Some work on commands The difference between keywords and "decorations" isn't important here.
2022-12-20 02:39:18 +08:00
- :doc:`abbr <cmds/abbr>` manages :ref:`abbreviations`.
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- :doc:`bind <cmds/bind>` to change bindings.
docs: Some work on commands The difference between keywords and "decorations" isn't important here.
2022-12-20 02:39:18 +08:00
- :doc:`complete <cmds/complete>` manages :ref:`completions <tab-completion>`.
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- :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.
docs: Hand-write a list of short descriptions in commands This is more readable than the full list, especially for the important things.
2021-10-23 22:46:15 +08:00
Known functions
^^^^^^^^^^^^^^^^
Known functions are a customization point. You can change them to change how your fish behaves. This includes:
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- :doc:`fish_prompt <cmds/fish_prompt>` and :doc:`fish_right_prompt <cmds/fish_right_prompt>` and :doc:`fish_mode_prompt <cmds/fish_mode_prompt>` to print your prompt.
- :doc:`fish_command_not_found <cmds/fish_command_not_found>` to tell fish what to do when a command is not found.
- :doc:`fish_title <cmds/fish_title>` to change the terminal's title.
- :doc:`fish_greeting <cmds/fish_greeting>` to show a greeting when fish starts.
Delete trailing whitespace
2021-12-03 01:08:36 +08:00
docs: Hand-write a list of short descriptions in commands This is more readable than the full list, especially for the important things.
2021-10-23 22:46:15 +08:00
Helper functions
^^^^^^^^^^^^^^^^
Some helper functions, often to give you information for use in your prompt:
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- :doc:`fish_git_prompt <cmds/fish_git_prompt>` and :doc:`fish_hg_prompt <cmds/fish_hg_prompt>` to print information about the current git or mercurial repository.
- :doc:`fish_vcs_prompt <cmds/fish_vcs_prompt>` to print information for either.
- :doc:`fish_svn_prompt <cmds/fish_svn_prompt>` to print information about the current svn repository.
- :doc:`fish_status_to_signal <cmds/fish_status_to_signal>` to give a signal name from a return status.
- :doc:`prompt_pwd <cmds/prompt_pwd>` to give the current directory in a nicely formatted and shortened way.
- :doc:`prompt_login <cmds/prompt_login>` to describe the current login, with user and hostname, and to explain if you are in a chroot or connected via ssh.
- :doc:`prompt_hostname <cmds/prompt_hostname>` to give the hostname, shortened for use in the 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").
docs: Some work on commands The difference between keywords and "decorations" isn't important here.
2022-12-20 02:39:18 +08:00
- :doc:`fish_delta <cmds/fish_delta>` to show what you have changed from the default configuration.
docs: Hand-write a list of short descriptions in commands This is more readable than the full list, especially for the important things.
2021-10-23 22:46:15 +08:00
Helper commands
^^^^^^^^^^^^^^^
fish also ships some things as external commands so they can be easily called from elsewhere.
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
This includes :doc:`fish_indent <cmds/fish_indent>` to format fish code and :doc:`fish_key_reader <cmds/fish_key_reader>` to show you what escape sequence a keypress produces.
docs: Hand-write a list of short descriptions in commands This is more readable than the full list, especially for the important things.
2021-10-23 22:46:15 +08:00
The full list
^^^^^^^^^^^^^
And here is the full list:
Break out commands into its own file
2019-02-11 10:01:37 +08:00
.. toctree::
:glob:
:maxdepth: 1
cmds/*
Reference in New Issue Copy Permalink