Skip to content

Commit

Permalink
doc: Quirks
Browse files Browse the repository at this point in the history
  • Loading branch information
KSXGitHub committed Jun 6, 2021
1 parent fd5f5bb commit 9d60e16
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ The [parallel-disk-usage crate](https://crates.io/crates/parallel-disk-usage) is

Alternatively, the `pdu` command provides `--json-input` flag and `--json-output` flag. The `--json-output` flag converts disk usage data into JSON and the `--json-input` flag turns said JSON into visualization. These 2 flags allow integration with other CLI tools (via pipe, as per the UNIX philosophy).

Beware that the structure of the JSON tree differs depends on the number of file/directory names that were provided (as CLI arguments):
* If there are only 0 or 1 file/directory names, the name of the tree root would be a real path (either `.` or the provided name).
* If there are 2 or more file/directory names, the name of the tree root would be `(total)` (which is not a real path), and the provided names would correspond to the children of the tree root.

## Installation

### Any Desktop OS
Expand Down

0 comments on commit 9d60e16

Please sign in to comment.