nvgn/hexyl
1
0 Fork 0
mirror of https://github.com/sharkdp/hexyl.git synced 2026-10-26 20:16:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve help text

Browse Source
This commit is contained in:
sharkdp authored and David Peter committed 2020-06-07 15:12:35 +02:00
1 parent ccfceaf58c
commit 3ca002638c
2 files changed
+24 -13
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CHANGELOG.md
+2 -3
View File
@@ -2,9 +2,8 @@
## Features
- Added a new `--skip <N>` / `-s <N>` option to skip the first `N` bytes of the input, see #16, #88
(Thanks to @Tarnadas, @MaxJohansen)
- The `--length`/`--bytes`/`--skip` options can now take units for their value argument, for example:
- A new `--skip <N>` / `-s <N>` option can be used to skip the first `N` bytes of the input, see #16, #88 (@Tarnadas, @MaxJohansen, @ErichDonGubler)
- The `--length`/`--bytes`/`--skip`/`--display-offset` options can now take units for their value argument, for example:
``` bash
hexyl /dev/random --length=1KiB
hexyl $(which hexyl) --skip=1MiB --length=10KiB
src/bin/hexyl.rs
+22 -10
View File
@@ -19,14 +19,21 @@ fn run() -> Result<(), Box<dyn std::error::Error>> {
.setting(AppSettings::UnifiedHelpMessage)
.version(crate_version!())
.about(crate_description!())
.arg(Arg::with_name("file").help("File to display"))
.arg(
Arg::with_name("FILE")
.help("The file to display. If no FILE argument is given, read from STDIN."),
)
.arg(
Arg::with_name("length")
.short("n")
.long("length")
.takes_value(true)
.value_name("N")
.help("Read only N bytes from the input"),
.help(
"Only read N bytes from the input. The N argument can also include a \
unit with a decimal prefix (kB, MB, ..) or binary prefix (kiB, MiB, ..).\n\
Examples: --length=64, --length=4KiB",
),
)
.arg(
Arg::with_name("bytes")
@@ -42,7 +49,10 @@ fn run() -> Result<(), Box<dyn std::error::Error>> {
.long("skip")
.takes_value(true)
.value_name("N")
.help("Skip first N bytes"),
.help(
"Skip the first N bytes of the input. The N argument can also include \
a unit (see `--length` for details)",
),
)
.arg(
Arg::with_name("block_size")
@@ -50,8 +60,8 @@ fn run() -> Result<(), Box<dyn std::error::Error>> {
.takes_value(true)
.value_name("SIZE")
.help(
"Sets the size of the `block` unit to SIZE. Examples: \
--block-size=1024, --block-size=4kB",
"Sets the size of the `block` unit to SIZE.\n\
Examples: --block-size=1024, --block-size=4kB",
),
)
.arg(
@@ -68,7 +78,7 @@ fn run() -> Result<(), Box<dyn std::error::Error>> {
Arg::with_name("color")
.long("color")
.takes_value(true)
.value_name("when")
.value_name("WHEN")
.possible_values(&["always", "auto", "never"])
.default_value("always")
.help(
@@ -80,24 +90,26 @@ fn run() -> Result<(), Box<dyn std::error::Error>> {
Arg::with_name("border")
.long("border")
.takes_value(true)
.value_name("STYLE")
.possible_values(&["unicode", "ascii", "none"])
.default_value("unicode")
.help("Whether to draw a border with unicode or ASCII characters, or none at all"),
.help("Whether to draw a border with Unicode characters, ASCII characters, or none at all"),
)
.arg(
Arg::with_name("display_offset")
.short("o")
.long("display-offset")
.takes_value(true)
.value_name("OFFSET")
.help("Add OFFSET to the displayed file position."),
.value_name("N")
.help("Add N bytes to the displayed file position. The N argument can also include \
a unit (see `--length` for details)"),
);
let matches = app.get_matches_safe()?;
let stdin = io::stdin();
let mut reader: Input = match matches.value_of("file") {
let mut reader: Input = match matches.value_of("FILE") {
Some(filename) => Input::File(File::open(filename)?),
None => Input::Stdin(stdin.lock()),
};