aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2021-03-12 01:26:13 -0500
committerJoseph Hunkeler <jhunkeler@gmail.com>2021-03-12 01:26:13 -0500
commit555f483a1860c76e6bf375124c645cf653d96c2b (patch)
tree622e627ceef0025c7670aa7998d8f0a979b8cfc0
parentd2915dc3516ede1d24891e7ab60ef9df670b273e (diff)
downloadreloc-555f483a1860c76e6bf375124c645cf653d96c2b.tar.gz
Update README usage block
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index 002663f..b0ca7b6 100644
--- a/README.md
+++ b/README.md
@@ -36,16 +36,20 @@ $ make install
## Usage
```
-$ reloc <str1> <str2> <input_file> <output_file>
+usage: reloc [-hV] <str1> <str2> <input_file> [output_file]
-Arguments:
-str1 - Pattern to search for
-str2 - Replace str1 with contents of str2
-input_file - Path to input file
-output_file - Path to output file
+Options:
+--help (-h) - Display this help message and exit
+--version (-V) - Display version and exit
+
+Positional arguments:
+str1 - Search string
+str2 - Replacement string
+input_file - Input file name
+output_file - Output file name
Example:
-reloc /original/path /new/path input.bin output.bin
+reloc /original/string /new/string input.bin output.bin
```
## Showcase