Skip to content

Commit

Permalink
doc: update readme and description
Browse files Browse the repository at this point in the history
  • Loading branch information
YC committed Dec 3, 2023
1 parent 198123f commit 6db7f20
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "safe-ascii"
version = "1.2.0"
description = "A tool for sanitising files to printable ASCII characters."
description = "A tool for sanitising input to printable ASCII characters."
authors = ["Steven Tang <[email protected]>"]
homepage = "https://github.com/YC/safe_ascii"
repository = "https://github.com/YC/safe_ascii"
Expand Down
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,29 @@ Usage: safe-ascii [OPTIONS] [files]...
Arguments:
[files]...
A list of files to process.
Use '-' for stdin
Use '-' for stdin.
Options:
-m, --mode <mnemonic|escape|suppress>
mnemonic: abbreviation e.g. (NUL), (SP), (NL)
escape: \x sequence, e.g. \x00, \x20, \x0a
suppress: don't print non-printable characters
Mode of character conversion/suppression.
[default: mnemonic]
[possible values: mnemonic, escape, suppress]
Possible values:
- mnemonic: Abbreviation, e.g. (NUL), (SP), (NL)
- escape: Hex sequence, e.g. \x00, \x20, \x0a
- suppress: Suppress non-printable characters
-t, --truncate <truncate-length>
length (bytes) to truncate at, -1 means no truncation
Length (bytes) to truncate at, -1 represents no truncation.
[default: -1]
-x, --exclude <exclude-characters>
comma-delimited decimal values of characters to print
Comma-delimited decimal values of characters to print.
(9 is HT (tab), 10 is NL (newline), 13 is CR (carriage return), 32 is SP (space))
[default: 10,32]
-h, --help
Print help information (use `-h` for a summary)
-V, --version
Print version information
```

### Example
Expand Down

0 comments on commit 6db7f20

Please sign in to comment.