From bed69b00c54b6bf00fe9349178648a090f18f336 Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Sat, 10 Aug 2019 20:50:32 +1000 Subject: [PATCH] Add comment on installing cmd/ractool --- cmd/ractool/data.go | 44 +++++++++++++++++++++++++------------------- cmd/ractool/main.go | 44 +++++++++++++++++++++++++------------------- 2 files changed, 50 insertions(+), 38 deletions(-) diff --git a/cmd/ractool/data.go b/cmd/ractool/data.go index 6130a61c..55e63a10 100644 --- a/cmd/ractool/data.go +++ b/cmd/ractool/data.go @@ -18,7 +18,7 @@ package main const usageStr = `Usage: -ractool [flags] [input_filename] + ractool [flags] [input_filename] If no input_filename is given, stdin is used. Either way, output is written to stdout. @@ -59,30 +59,36 @@ The "256k" flag value means 256 kibibytes (262144 bytes). Similarly, "1m" and General Flags: --decode - whether to decode the input --encode - whether to encode the input + -decode + whether to decode the input + -encode + whether to encode the input Decode-Related Flags: --drange - the "i:j" range to decompress, ":8" means the first 8 bytes + -drange + the "i:j" range to decompress, ":8" means the first 8 bytes Encode-Related Flags: --cchunksize - the chunk size (in CSpace) --codec - the compression codec (default "zlib") --cpagesize - the page size (in CSpace) --dchunksize - the chunk size (in DSpace) --indexlocation - the index location, "start" or "end" (default "start") --resources - comma-separated list of resource files, such as shared dictionaries + -cchunksize + the chunk size (in CSpace) + -codec + the compression codec (default "zlib") + -cpagesize + the page size (in CSpace) + -dchunksize + the chunk size (in DSpace) + -indexlocation + the index location, "start" or "end" (default "start") + -resources + comma-separated list of resource files, such as shared dictionaries + +Installation: + +Like any other implemented-in-Go program, to install the ractool program: + + go get github.com/google/wuffs/cmd/ractool Extended Example: diff --git a/cmd/ractool/main.go b/cmd/ractool/main.go index bfa54422..2977e95c 100644 --- a/cmd/ractool/main.go +++ b/cmd/ractool/main.go @@ -24,7 +24,7 @@ https://github.com/google/wuffs/blob/master/doc/spec/rac-spec.md Usage: -ractool [flags] [input_filename] + ractool [flags] [input_filename] If no input_filename is given, stdin is used. Either way, output is written to stdout. @@ -65,30 +65,36 @@ The "256k" flag value means 256 kibibytes (262144 bytes). Similarly, "1m" and General Flags: --decode - whether to decode the input --encode - whether to encode the input + -decode + whether to decode the input + -encode + whether to encode the input Decode-Related Flags: --drange - the "i:j" range to decompress, ":8" means the first 8 bytes + -drange + the "i:j" range to decompress, ":8" means the first 8 bytes Encode-Related Flags: --cchunksize - the chunk size (in CSpace) --codec - the compression codec (default "zlib") --cpagesize - the page size (in CSpace) --dchunksize - the chunk size (in DSpace) --indexlocation - the index location, "start" or "end" (default "start") --resources - comma-separated list of resource files, such as shared dictionaries + -cchunksize + the chunk size (in CSpace) + -codec + the compression codec (default "zlib") + -cpagesize + the page size (in CSpace) + -dchunksize + the chunk size (in DSpace) + -indexlocation + the index location, "start" or "end" (default "start") + -resources + comma-separated list of resource files, such as shared dictionaries + +Installation: + +Like any other implemented-in-Go program, to install the ractool program: + + go get github.com/google/wuffs/cmd/ractool Extended Example: