h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-05-01 01:51:14 -03:00
Code Issues Packages Projects Releases Wiki Activity

Switch backticks to double backticks for rst compatibility

Browse Source
This commit is contained in:
ridiculousfish
2018-12-19 12:02:45 -08:00
parent 2a002a4ba1
commit 0e936198db
84 changed files with 825 additions and 825 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
sphinx_doc_src/cmds/alias.rst
View File

@@ -12,25 +12,25 @@ alias [OPTIONS] NAME=DEFINITION
Description
------------
`alias` is a simple wrapper for the `function` builtin, which creates a function wrapping a command. It has similar syntax to POSIX shell `alias`. For other uses, it is recommended to define a <a href='#function'>function</a>.
``alias`` is a simple wrapper for the ``function`` builtin, which creates a function wrapping a command. It has similar syntax to POSIX shell ``alias``. For other uses, it is recommended to define a <a href='#function'>function</a>.
`fish` marks functions that have been created by `alias` by including the command used to create them in the function description. You can list `alias`-created functions by running `alias` without arguments. They must be erased using `functions -e`.
``fish`` marks functions that have been created by ``alias`` by including the command used to create them in the function description. You can list ``alias``-created functions by running ``alias`` without arguments. They must be erased using ``functions -e``.
- `NAME` is the name of the alias
- `DEFINITION` is the actual command to execute. The string `$argv` will be appended.
- ``NAME`` is the name of the alias
- ``DEFINITION`` is the actual command to execute. The string ``$argv`` will be appended.
You cannot create an alias to a function with the same name. Note that spaces need to be escaped in the call to `alias` just like at the command line, _even inside quoted parts_.
You cannot create an alias to a function with the same name. Note that spaces need to be escaped in the call to ``alias`` just like at the command line, _even inside quoted parts_.
The following options are available:
- `-h` or `--help` displays help about using this command.
- ``-h`` or ``--help`` displays help about using this command.
- `-s` or `--save` Automatically save the function created by the alias into your fish configuration directory using <a href='#funcsave'>funcsave</a>.
- ``-s`` or ``--save`` Automatically save the function created by the alias into your fish configuration directory using <a href='#funcsave'>funcsave</a>.
Example
------------
The following code will create `rmi`, which runs `rm` with additional arguments on every invocation.
The following code will create ``rmi``, which runs ``rm`` with additional arguments on every invocation.