mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-26 04:43:10 +00:00
docs: Fix typos
This commit is contained in:
parent
ee1018ab53
commit
ade61fd50f
10 changed files with 16 additions and 16 deletions
|
@ -27,7 +27,7 @@ The ``fish_git_prompt`` function displays information about the current git repo
|
||||||
There are numerous customization options, which can be controlled with git options or fish variables. git options, where available, take precedence over the fish variable with the same function. git options can be set on a per-repository or global basis. git options can be set with the ``git config`` command, while fish variables can be set as usual with the :ref:`set <cmd-set>` command.
|
There are numerous customization options, which can be controlled with git options or fish variables. git options, where available, take precedence over the fish variable with the same function. git options can be set on a per-repository or global basis. git options can be set with the ``git config`` command, while fish variables can be set as usual with the :ref:`set <cmd-set>` command.
|
||||||
|
|
||||||
- ``$__fish_git_prompt_show_informative_status`` or the git option ``bash.showInformativeStatus`` can be set to enable the "informative" display, which will show a large amount of information - the number of dirty files, unpushed/unpulled commits, and more.
|
- ``$__fish_git_prompt_show_informative_status`` or the git option ``bash.showInformativeStatus`` can be set to enable the "informative" display, which will show a large amount of information - the number of dirty files, unpushed/unpulled commits, and more.
|
||||||
In large repositories, this can take a lot of time, so it you may wish to disable it in these repositories with ``git config --local bash.showInformativeStatus false``. It also changes the characters the prompt uses to less plain ones (``✚`` instead of ``*`` for the dirty state for example) , and if you are only interested in that, set ``$__fish_git_prompt_use_informative_chars`` instead.
|
In large repositories, this can take a lot of time, so you may wish to disable it in these repositories with ``git config --local bash.showInformativeStatus false``. It also changes the characters the prompt uses to less plain ones (``✚`` instead of ``*`` for the dirty state for example) , and if you are only interested in that, set ``$__fish_git_prompt_use_informative_chars`` instead.
|
||||||
|
|
||||||
Because counting untracked files requires a lot of time, the number of untracked files is only shown if enabled via ``$__fish_git_prompt_showuntrackedfiles`` or the git option ``bash.showUntrackedFiles``.
|
Because counting untracked files requires a lot of time, the number of untracked files is only shown if enabled via ``$__fish_git_prompt_showuntrackedfiles`` or the git option ``bash.showUntrackedFiles``.
|
||||||
|
|
||||||
|
|
|
@ -36,7 +36,7 @@ Description
|
||||||
**-h** or **--help**
|
**-h** or **--help**
|
||||||
Displays help about using this command.
|
Displays help about using this command.
|
||||||
|
|
||||||
On systems that supports this feature, jobs will print the CPU usage of each job since the last command was executed. The CPU usage is expressed as a percentage of full CPU activity. Note that on multiprocessor systems, the total activity may be more than 100\%.
|
On systems that support this feature, jobs will print the CPU usage of each job since the last command was executed. The CPU usage is expressed as a percentage of full CPU activity. Note that on multiprocessor systems, the total activity may be more than 100\%.
|
||||||
|
|
||||||
Arguments of the form *PID* or *%JOBID* restrict the output to jobs with the selected process identifiers or job numbers respectively.
|
Arguments of the form *PID* or *%JOBID* restrict the output to jobs with the selected process identifiers or job numbers respectively.
|
||||||
|
|
||||||
|
|
|
@ -136,7 +136,7 @@ Functions
|
||||||
0x1
|
0x1
|
||||||
|
|
||||||
``ceil``
|
``ceil``
|
||||||
round number up to nearest integer
|
round number up to the nearest integer
|
||||||
``cos``
|
``cos``
|
||||||
the cosine
|
the cosine
|
||||||
``cosh``
|
``cosh``
|
||||||
|
@ -146,7 +146,7 @@ Functions
|
||||||
``fac``
|
``fac``
|
||||||
factorial - also known as ``x!`` (``x * (x - 1) * (x - 2) * ... * 1``)
|
factorial - also known as ``x!`` (``x * (x - 1) * (x - 2) * ... * 1``)
|
||||||
``floor``
|
``floor``
|
||||||
round number down to nearest integer
|
round number down to the nearest integer
|
||||||
``ln``
|
``ln``
|
||||||
the base-e logarithm
|
the base-e logarithm
|
||||||
``log`` or ``log10``
|
``log`` or ``log10``
|
||||||
|
|
|
@ -20,7 +20,7 @@ Description
|
||||||
To see the documentation on the ``realpath`` command you might have,
|
To see the documentation on the ``realpath`` command you might have,
|
||||||
use ``command man realpath``.
|
use ``command man realpath``.
|
||||||
|
|
||||||
:program:`realpath` follows all symbolic links encountered for the provided :envvar:`PATH`, printing the absolute path resolved. :ref:`fish <cmd-fish>` provides a :command:`realpath`-alike builtin intended to be enrich systems where no such command is installed by default.
|
:program:`realpath` follows all symbolic links encountered for the provided :envvar:`PATH`, printing the absolute path resolved. :ref:`fish <cmd-fish>` provides a :command:`realpath`-alike builtin intended to enrich systems where no such command is installed by default.
|
||||||
|
|
||||||
If a :command:`realpath` command exists, that will be preferred.
|
If a :command:`realpath` command exists, that will be preferred.
|
||||||
``builtin realpath`` will explicitly use the fish implementation of :command:`realpath`.
|
``builtin realpath`` will explicitly use the fish implementation of :command:`realpath`.
|
||||||
|
|
|
@ -13,7 +13,7 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
``set_color`` is used to control the color and styling of text in the terminal. *VALUE* describes that styling. *VALUE* can be a reserved color name like **red** or a RGB color value given as 3 or 6 hexadecimal digits ("F27" or "FF2277"). A special keyword **normal** resets text formatting to terminal defaults.
|
``set_color`` is used to control the color and styling of text in the terminal. *VALUE* describes that styling. *VALUE* can be a reserved color name like **red** or an RGB color value given as 3 or 6 hexadecimal digits ("F27" or "FF2277"). A special keyword **normal** resets text formatting to terminal defaults.
|
||||||
|
|
||||||
Valid colors include:
|
Valid colors include:
|
||||||
|
|
||||||
|
|
|
@ -106,7 +106,7 @@ The ``fish`` implementation of ``ulimit`` should behave identically to the imple
|
||||||
|
|
||||||
- Fish ``ulimit`` supports GNU-style long options for all switches.
|
- Fish ``ulimit`` supports GNU-style long options for all switches.
|
||||||
|
|
||||||
- Fish ``ulimit`` does not support the **-p** option for getting the pipe size. The bash implementation consists of a compile-time check that empirically guesses this number by writing to a pipe and waiting for SIGPIPE. Fish does not do this because it this method of determining pipe size is unreliable. Depending on bash version, there may also be further additional limits to set in bash that do not exist in fish.
|
- Fish ``ulimit`` does not support the **-p** option for getting the pipe size. The bash implementation consists of a compile-time check that empirically guesses this number by writing to a pipe and waiting for SIGPIPE. Fish does not do this because this method of determining pipe size is unreliable. Depending on bash version, there may also be further additional limits to set in bash that do not exist in fish.
|
||||||
|
|
||||||
- Fish ``ulimit`` does not support getting or setting multiple limits in one command, except reporting all values using the **-a** switch.
|
- Fish ``ulimit`` does not support getting or setting multiple limits in one command, except reporting all values using the **-a** switch.
|
||||||
|
|
||||||
|
|
|
@ -94,7 +94,7 @@ Functions beginning with the string ``__fish_print_`` print a newline separated
|
||||||
|
|
||||||
- ``__fish_print_filesystems`` prints a list of all known file systems. Currently, this is a static list, and not dependent on what file systems the host operating system actually understands.
|
- ``__fish_print_filesystems`` prints a list of all known file systems. Currently, this is a static list, and not dependent on what file systems the host operating system actually understands.
|
||||||
|
|
||||||
- ``__fish_print_hostnames`` prints a list of all known hostnames. This functions searches the fstab for nfs servers, ssh for known hosts and checks the ``/etc/hosts`` file.
|
- ``__fish_print_hostnames`` prints a list of all known hostnames. This function searches the fstab for nfs servers, ssh for known hosts and checks the ``/etc/hosts`` file.
|
||||||
|
|
||||||
- ``__fish_print_interfaces`` prints a list of all known network interfaces.
|
- ``__fish_print_interfaces`` prints a list of all known network interfaces.
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,7 @@ This is a description of the design principles that have been used to design fis
|
||||||
|
|
||||||
1. Everything that can be done in other shell languages should be possible to do in fish, though fish may rely on external commands in doing so.
|
1. Everything that can be done in other shell languages should be possible to do in fish, though fish may rely on external commands in doing so.
|
||||||
|
|
||||||
2. Fish should be user friendly, but not at the expense of expressiveness. Most tradeoffs between power and ease of use can be avoided with careful design.
|
2. Fish should be user-friendly, but not at the expense of expressiveness. Most tradeoffs between power and ease of use can be avoided with careful design.
|
||||||
|
|
||||||
3. Whenever possible without breaking the above goals, fish should follow POSIX.
|
3. Whenever possible without breaking the above goals, fish should follow POSIX.
|
||||||
|
|
||||||
|
|
|
@ -77,8 +77,8 @@ Fish interprets the command line as it is typed and uses syntax highlighting to
|
||||||
|
|
||||||
Detected errors include:
|
Detected errors include:
|
||||||
|
|
||||||
- Non existing commands.
|
- Non-existing commands.
|
||||||
- Reading from or appending to a non existing file.
|
- Reading from or appending to a non-existing file.
|
||||||
- Incorrect use of output redirects
|
- Incorrect use of output redirects
|
||||||
- Mismatched parenthesis
|
- Mismatched parenthesis
|
||||||
|
|
||||||
|
@ -99,7 +99,7 @@ Or, to see all themes, right in your terminal::
|
||||||
Syntax highlighting variables
|
Syntax highlighting variables
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
The colors used by fish for syntax highlighting can be configured by changing the values of a various variables. The value of these variables can be one of the colors accepted by the :ref:`set_color <cmd-set_color>` command. The modifier switches accepted by ``set_color`` like ``--bold``, ``--dim``, ``--italics``, ``--reverse`` and ``--underline`` are also accepted.
|
The colors used by fish for syntax highlighting can be configured by changing the values of various variables. The value of these variables can be one of the colors accepted by the :ref:`set_color <cmd-set_color>` command. The modifier switches accepted by ``set_color`` like ``--bold``, ``--dim``, ``--italics``, ``--reverse`` and ``--underline`` are also accepted.
|
||||||
|
|
||||||
|
|
||||||
Example: to make errors highlighted and red, use::
|
Example: to make errors highlighted and red, use::
|
||||||
|
|
|
@ -178,7 +178,7 @@ The destination of a stream can be changed using something called *redirection*.
|
||||||
|
|
||||||
As a convenience, the redirection ``&>`` can be used to direct both stdout and stderr to the same destination. For example, ``echo hello &> all_output.txt`` redirects both stdout and stderr to the file ``all_output.txt``. This is equivalent to ``echo hello > all_output.txt 2>&1``.
|
As a convenience, the redirection ``&>`` can be used to direct both stdout and stderr to the same destination. For example, ``echo hello &> all_output.txt`` redirects both stdout and stderr to the file ``all_output.txt``. This is equivalent to ``echo hello > all_output.txt 2>&1``.
|
||||||
|
|
||||||
Any arbitrary file descriptor can used in a redirection by prefixing the redirection with the FD number.
|
Any arbitrary file descriptor can be used in a redirection by prefixing the redirection with the FD number.
|
||||||
|
|
||||||
- To redirect the input of descriptor N, use ``N<DESTINATION``.
|
- To redirect the input of descriptor N, use ``N<DESTINATION``.
|
||||||
- To redirect the output of descriptor N, use ``N>DESTINATION``.
|
- To redirect the output of descriptor N, use ``N>DESTINATION``.
|
||||||
|
@ -592,7 +592,7 @@ Command substitution
|
||||||
|
|
||||||
The output of a command (or an entire :ref:`pipeline <pipes>`) can be used as the arguments to another command.
|
The output of a command (or an entire :ref:`pipeline <pipes>`) can be used as the arguments to another command.
|
||||||
|
|
||||||
When you write a command in parenthesis like ``outercommand (innercommand)``, the ``innercommand`` will be executed first. Its output will be taken and each line given as a separate argument to ``outercommand``, which will then be executed. [#]_
|
When you write a command in parentheses like ``outercommand (innercommand)``, the ``innercommand`` will be executed first. Its output will be taken and each line given as a separate argument to ``outercommand``, which will then be executed. [#]_
|
||||||
|
|
||||||
A command substitution can have a dollar sign before the opening parenthesis like ``outercommand $(innercommand)``. This variant is also allowed inside double quotes. When using double quotes, the command output is not split up by lines.
|
A command substitution can have a dollar sign before the opening parenthesis like ``outercommand $(innercommand)``. This variant is also allowed inside double quotes. When using double quotes, the command output is not split up by lines.
|
||||||
|
|
||||||
|
@ -1544,7 +1544,7 @@ For a list of all builtins, functions and commands shipped with fish, see the :r
|
||||||
Shell variable and function names
|
Shell variable and function names
|
||||||
---------------------------------
|
---------------------------------
|
||||||
|
|
||||||
The names given to variables and functions (so called "identifiers") have to follow certain rules:
|
The names given to variables and functions (so-called "identifiers") have to follow certain rules:
|
||||||
|
|
||||||
- A variable name cannot be empty. It can contain only letters, digits, and underscores. It may begin and end with any of those characters.
|
- A variable name cannot be empty. It can contain only letters, digits, and underscores. It may begin and end with any of those characters.
|
||||||
|
|
||||||
|
@ -1660,6 +1660,6 @@ For more information on how to define new event handlers, see the documentation
|
||||||
Debugging fish scripts
|
Debugging fish scripts
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
Fish includes a built in debugging facility. The debugger allows you to stop execution of a script at an arbitrary point. When this happens you are presented with an interactive prompt. At this prompt you can execute any fish command (there are no debug commands as such). For example, you can check or change the value of any variables using :ref:`printf <cmd-printf>` and :ref:`set <cmd-set>`. As another example, you can run :ref:`status print-stack-trace <cmd-status>` to see how this breakpoint was reached. To resume normal execution of the script, simply type :ref:`exit <cmd-exit>` or :kbd:`Control`\ +\ :kbd:`D`.
|
Fish includes a built-in debugging facility. The debugger allows you to stop execution of a script at an arbitrary point. When this happens you are presented with an interactive prompt. At this prompt you can execute any fish command (there are no debug commands as such). For example, you can check or change the value of any variables using :ref:`printf <cmd-printf>` and :ref:`set <cmd-set>`. As another example, you can run :ref:`status print-stack-trace <cmd-status>` to see how this breakpoint was reached. To resume normal execution of the script, simply type :ref:`exit <cmd-exit>` or :kbd:`Control`\ +\ :kbd:`D`.
|
||||||
|
|
||||||
To start a debug session simply run the builtin command :ref:`breakpoint <cmd-breakpoint>` at the point in a function or script where you wish to gain control. Also, the default action of the TRAP signal is to call this builtin. So a running script can be debugged by sending it the TRAP signal with the ``kill`` command. Once in the debugger, it is easy to insert new breakpoints by using the funced function to edit the definition of a function.
|
To start a debug session simply run the builtin command :ref:`breakpoint <cmd-breakpoint>` at the point in a function or script where you wish to gain control. Also, the default action of the TRAP signal is to call this builtin. So a running script can be debugged by sending it the TRAP signal with the ``kill`` command. Once in the debugger, it is easy to insert new breakpoints by using the funced function to edit the definition of a function.
|
||||||
|
|
Loading…
Reference in a new issue