diff --git a/src/main.rs b/src/main.rs index 1b5b68a..c6ef49a 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,35 +1,38 @@ -/// -/// - dutree - -/// -/// Simple command to analyse disk usage from the terminal -/// -/// Usage: -/// btrfs-sync [options] [...] [[user@]host:] -/// -/// -k|--keep NUM keep only last sync'ed snapshots -/// -d|--delete delete snapshots in that don't exist in -/// -z|--xz use xz compression. Saves bandwidth, but uses one CPU -/// -Z|--pbzip2 use pbzip2 compression. Saves bandwidth, but uses all CPUs -/// -q|--quiet don't display progress -/// -v|--verbose display more information -/// -h|--help show usage -/// -/// can either be a single snapshot, or a folder containing snapshots -/// requires privileged permissions at for the 'btrfs' command -/// -/// Cron example: daily synchronization over the internet, keep only last 50 -/// -/// cat > /etc/cron.daily/btrfs-sync < -/// GPL licensed (see end of file) * Use at your own risk! -/// -/// More at https://ownyourbits.com -/// +//! +//! Simple command line tool to analyse disk usage from the terminal +//! +//! # Usage +//! +//! ```text +//! $ dutree --help +//! Usage: dutree [options] [..] +//! +//! Options: +//! -d, --depth [DEPTH] show directories up to depth N (def 1) +//! -a, --aggr [N[KMG]] aggregate smaller than N B/KiB/MiB/GiB (def 1M) +//! -s, --summary equivalent to -da, or -d1 -a1M +//! -u, --usage report real disk usage instead of file size +//! -b, --bytes print sizes in bytes +//! -x, --exclude NAME exclude matching files or directories +//! -H, --no-hidden exclude hidden files +//! -A, --ascii ASCII characters only, no colors +//! -h, --help show help +//! -v, --version print version number +//! ``` +//! # Screenshot +//! +//! ![dutree](https://ownyourbits.com/wp-content/uploads/2018/03/dutree-featured2.png) +//! +//! # More information +//! +//! Copyleft 2018 by Ignacio Nunez Hernanz - nacho _at_ ownyourbits _dot_ com +//! +//! GPL licensed +//! +//! More at [ownyourbits.com](https://ownyourbits.com/2018/03/25/analize-disk-usage-with-dutree) +//! +//! [github](https://github.com/nachoparker/dutree) +//! extern crate dutree;