Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-11-10 15:14:44 +00:00
Code Issues Projects Releases Packages Wiki Activity

Another pass over the docs

Browse source
This commit is contained in:
Fabian Homborg 2021-10-11 21:02:17 +02:00
parent 9f174d3a62
commit fbfad686aa
1 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
doc_src/cmds/path.rst
View file

@ -12,8 +12,10 @@ Synopsis
path dir GENERAL_OPTIONS [PATH...] path dir GENERAL_OPTIONS [PATH...]
path extension GENERAL_OPTIONS [PATH...] path extension GENERAL_OPTIONS [PATH...]
path filter GENERAL_OPTIONS [(-v | --invert)] \ path filter GENERAL_OPTIONS [(-v | --invert)] \
[-d] [-f] [-l] [-r] [-w] [-x] \
[(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH...] [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH...]
path is GENERAL_OPTIONS [(-v | --invert)] [(-t | --type) TYPE] \ path is GENERAL_OPTIONS [(-v | --invert)] [(-t | --type) TYPE] \
[-d] [-f] [-l] [-r] [-w] [-x] \
[(-p | --perm) PERMISSION] [PATH...] [(-p | --perm) PERMISSION] [PATH...]
path normalize GENERAL_OPTIONS [PATH...] path normalize GENERAL_OPTIONS [PATH...]
path real GENERAL_OPTIONS [PATH...] path real GENERAL_OPTIONS [PATH...]
@ -94,11 +96,11 @@ Examples
>_ path dir ./foo.mp4 >_ path dir ./foo.mp4
. .
>_ path base ../banana >_ path dir ../banana
banana ..
>_ path base /usr/bin/ >_ path dir /usr/bin/
bin /usr
"extension" subcommand "extension" subcommand
----------------------- -----------------------
@ -138,7 +140,9 @@ Examples
:: ::
path filter [(-z | --null-in)] [(-Z | --null-out)] [(-q | --quiet)] [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH...] path filter [(-z | --null-in)] [(-Z | --null-out)] [(-q | --quiet)] \
[-d] [-f] [-l] [-r] [-w] [-x] \
[(-v | --invert)] [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH...]
``path filter`` returns all of the given paths that match the given checks. In all cases, the paths need to exist, nonexistent paths are always filtered. ``path filter`` returns all of the given paths that match the given checks. In all cases, the paths need to exist, nonexistent paths are always filtered.
@ -186,6 +190,9 @@ Examples
# "-x" is short for "--perm=exec" and "-w" short for "--perm=write"! # "-x" is short for "--perm=exec" and "-w" short for "--perm=write"!
/home/me /home/me
>_ path filter -fx $PATH/*
# Prints all possible commands - the first entry of each name is what fish would execute!
.. _cmd-path-is: .. _cmd-path-is:
"is" subcommand "is" subcommand
@ -193,7 +200,9 @@ Examples
:: ::
path is [(-z | --null-in)] [(-Z | --null-out)] [(-q | --quiet)] [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH...] path is [(-z | --null-in)] [(-Z | --null-out)] [(-q | --quiet)] \
[-d] [-f] [-l] [-r] [-w] [-x] \
[(-v | --invert)] [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH...]
``path is`` is short for ``path filter -q``. It returns true if any of the given files passes the filter, but does not produce any output. ``path is`` is short for ``path filter -q``. It returns true if any of the given files passes the filter, but does not produce any output.
@ -265,7 +274,7 @@ Examples
:: ::
path strip-extension [(-z | --null-in)] [(-Z | --null-out)] [(-q | --quiet)] [PATH...] path strip-extension [(-z | --null-in)] [(-Z | --null-out)] [(-q | --quiet)] [PATH...]
``path strip-extension`` returns the given paths without the extension. This is the part after (and excluding) the last ".", unless that "." followed a "/" or the basename is "." or "..", in which case there is no extension and the full path is printed. ``path strip-extension`` returns the given paths without the extension. The extension is the part after (and excluding) the last ".", unless that "." followed a "/" or the basename is "." or "..", in which case there is no extension and the full path is printed.
This is, of course, the inverse of ``path extension``. This is, of course, the inverse of ``path extension``.