diff options
| author | Canop <cano.petrole@gmail.com> | 2023-07-02 21:20:28 +0200 |
|---|---|---|
| committer | Canop <cano.petrole@gmail.com> | 2023-07-02 21:20:28 +0200 |
| commit | bbe9b556192b72692af7be7f40cc1c7a46fbd71c (patch) | |
| tree | 019b6ddb56fed599cbec7d1804a2b4644ad133d9 | |
| parent | 0e0ce4aa04c2100e113a49d6993df65f6bbd6f3c (diff) | |
update doc following renamingv2.6.1
20 files changed, 30 insertions, 20 deletions
diff --git a/website/docs/community.md b/website/docs/community.md index 549c2b1..a8725d3 100644 --- a/website/docs/community.md +++ b/website/docs/community.md @@ -1,6 +1,14 @@ **dysk** is developed by [Denys Séguret](https://twitter.com/DenysSeguret), also known as [Canop](https://github.com/Canop) or [dystroy](https://dystroy.org). +# Sponsorship + +**dysk** is free for all uses. + +If it helps your company make money, consider helping me find time to add features and to develop new free open-source software. + +<iframe src="https://github.com/sponsors/Canop/button" title="Sponsor Canop" height="35" width="114" style="border: 0; border-radius: 6px;"></iframe> + # Chat The best place to chat about dysk, to talk about features or bugs, is the Miaou chat. diff --git a/website/docs/filters.md b/website/docs/filters.md index 730d72e..9f70018 100644 --- a/website/docs/filters.md +++ b/website/docs/filters.md @@ -9,7 +9,7 @@ There are several ways to choose the filesystems of either the table or the JSON The default selection of filesystems showcases your storage, avoiding any filesystem which both have no "disk" and aren't remote ones, bound to another filesystem, etc. - + Here are the rules of the current heuristics, in order: a filesystem @@ -21,7 +21,7 @@ Here are the rules of the current heuristics, in order: a filesystem To see *all* filesystems of your system, do `dysk --all`: - + This list can be quite big with virtual file systems, docker use, etc. @@ -31,7 +31,7 @@ If you're only interested in the device on which some file is, give the path as For example, for the current device, use `dysk .`: - + # Filter argument @@ -41,6 +41,8 @@ A constraint can be related to any [column](../table#all-columns). You can for example fetch the filesystems with a given type with `dysk -f 'type=xfs'`. +Or remote volumes with `dysk -f 'remote=true'`. + The operators you can apply to a column are the following ones: |operator|meaning| @@ -58,12 +60,12 @@ You can combine several column conditions with boolean operators `|` (or), `&` ( For example you may want to select the volumes with not enough space with ```bash -dysk -f 'free<100G | use>75%' +dysk -f 'free<100G | use>65%' ``` Examples: - + !!! Note Only *normal* filesystems are shown unless you use `-a`. This applies even when you use the `--filter` argument. diff --git a/website/docs/img/dysk-json-jq.png b/website/docs/img/dysk-json-jq.png Binary files differnew file mode 100644 index 0000000..a5f0200 --- /dev/null +++ b/website/docs/img/dysk-json-jq.png diff --git a/website/docs/img/dysk.png b/website/docs/img/dysk.png Binary files differnew file mode 100644 index 0000000..89506dd --- /dev/null +++ b/website/docs/img/dysk.png diff --git a/website/docs/img/dysk_c=+dev+inodes.png b/website/docs/img/dysk_c=+dev+inodes.png Binary files differnew file mode 100644 index 0000000..5bf6918 --- /dev/null +++ b/website/docs/img/dysk_c=+dev+inodes.png diff --git a/website/docs/img/dysk_c=-fs+type.png b/website/docs/img/dysk_c=-fs+type.png Binary files differnew file mode 100644 index 0000000..39380e0 --- /dev/null +++ b/website/docs/img/dysk_c=-fs+type.png diff --git a/website/docs/img/dysk_c=all.png b/website/docs/img/dysk_c=all.png Binary files differnew file mode 100644 index 0000000..c5c31ab --- /dev/null +++ b/website/docs/img/dysk_c=all.png diff --git a/website/docs/img/dysk_c=default.png b/website/docs/img/dysk_c=default.png Binary files differnew file mode 100644 index 0000000..c8fc028 --- /dev/null +++ b/website/docs/img/dysk_c=default.png diff --git a/website/docs/img/dysk_c=label+.png b/website/docs/img/dysk_c=label+.png Binary files differnew file mode 100644 index 0000000..322bb11 --- /dev/null +++ b/website/docs/img/dysk_c=label+.png diff --git a/website/docs/img/dysk_c=label+default+dev.png b/website/docs/img/dysk_c=label+default+dev.png Binary files differnew file mode 100644 index 0000000..cb38632 --- /dev/null +++ b/website/docs/img/dysk_c=label+default+dev.png diff --git a/website/docs/img/dysk_c=label+use+size+disk+mount.png b/website/docs/img/dysk_c=label+use+size+disk+mount.png Binary files differnew file mode 100644 index 0000000..8bd8d9d --- /dev/null +++ b/website/docs/img/dysk_c=label+use+size+disk+mount.png diff --git a/website/docs/img/dysk_filters.png b/website/docs/img/dysk_filters.png Binary files differnew file mode 100644 index 0000000..c5b7bd8 --- /dev/null +++ b/website/docs/img/dysk_filters.png diff --git a/website/docs/img/dysk_rows-all.png b/website/docs/img/dysk_rows-all.png Binary files differnew file mode 100644 index 0000000..013996f --- /dev/null +++ b/website/docs/img/dysk_rows-all.png diff --git a/website/docs/img/dysk_rows-current.png b/website/docs/img/dysk_rows-current.png Binary files differnew file mode 100644 index 0000000..32b9f38 --- /dev/null +++ b/website/docs/img/dysk_rows-current.png diff --git a/website/docs/img/dysk_rows-standard.png b/website/docs/img/dysk_rows-standard.png Binary files differnew file mode 100644 index 0000000..735f74c --- /dev/null +++ b/website/docs/img/dysk_rows-standard.png diff --git a/website/docs/img/dysk_s=dev.png b/website/docs/img/dysk_s=dev.png Binary files differnew file mode 100644 index 0000000..cb58851 --- /dev/null +++ b/website/docs/img/dysk_s=dev.png diff --git a/website/docs/img/dysk_s=free-d.png b/website/docs/img/dysk_s=free-d.png Binary files differnew file mode 100644 index 0000000..1f0feb3 --- /dev/null +++ b/website/docs/img/dysk_s=free-d.png diff --git a/website/docs/index.md b/website/docs/index.md index a0bc83c..f52044e 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -1,11 +1,11 @@ -*dysk was previously known as lfs but was renamed because that name was used by too many things.* +*dysk was previously known as lfs but was renamed because that name was found to be used by previous programs.* # Purpose **dysk** is a linux utility listing your filesystems. - + Usage is shown in a graphical way. @@ -26,7 +26,7 @@ All sizes are normally based on the current SI recommendations (1M is one millio The default display of **dysk** is a table, which can be configured with the columns of your choice. - + See [Table](./table) for the definition of the columns and the syntax for choosing them, or on how to [sort rows](./table#sort). @@ -36,10 +36,10 @@ The table can also be exported in [CSV](./table#csv). `dysk --json` outputs the result as JSON which can be used for your own scripts or programs. - + # Filters The query syntax lets you specify the filesystems you want: - + diff --git a/website/docs/json.md b/website/docs/json.md index a14c9dd..2d93039 100644 --- a/website/docs/json.md +++ b/website/docs/json.md @@ -69,5 +69,5 @@ The output of `dysk -j` can be piped into another program. You can for example use [jq](https://stedolan.github.io/jq/) to filter or extract data: - + diff --git a/website/docs/table.md b/website/docs/table.md index f5744c9..d48a406 100644 --- a/website/docs/table.md +++ b/website/docs/table.md @@ -36,40 +36,40 @@ With the `--cols` launch argument, shortened as `-c`, you can change the display The default set is defined for the casual usage of checking the available volumes and their filling level: - + With `-c all`, you may see all available columns, but that's normally too much for convenience: - + The most obvious use of the `--cols` argument is the explicit definition of the columns to display. For example `dysk -c label+use+size+disk+mount` will show the `label`, `use`, `size`, `disk`, and `mount` columns, in that order: - + All the default columns (see [table above](#columns)) can be inserted with just `default`. Here's adding the label at the start and the device id at the end, with `dysk -c label+default+dev`: - + If the `--cols` argument starts or ends with `+` or `-`, the `default` set of columns is implied. To add the device id and the share of inodes used to the default columns, you do `dysk -c +dev+inodes`: - + To preprend the `label` column before the default ones, use `dysk -c label+`: - + The `-` sign removes columns. And adding an already present column moves it to the end (there's never duplicates). Here's removing the `fs` column and moving the `type` column to the end, with `dysk -c -fs+type`: - + # Sort @@ -82,11 +82,11 @@ The `desc` and `asc` directions can be abbreviated into `d` and `a`. For example, sorting on the device id: - + Or sorting on the remaining free space, in descending order: - + # CSV |
