Skip to content

Commit 0543cee

Browse files
committed
[General] Minor wording and formatting changes to usage message
Update usage message in README
1 parent 5a2d912 commit 0543cee

File tree

2 files changed

+29
-9
lines changed

2 files changed

+29
-9
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ Options:
3636
the specified directory, otherwise all classes found
3737
are written to this directory at the top level
3838
-m <m>, --color=<m> Set color settings, one of the below
39-
default: color output only if output is to a TTY
39+
default: color output using ASNI color escapes only if output is to a TTY
4040
never: no output is colored
41-
always: output to TTYs, pipes, and files are colored
41+
always: color output to files, pipes, and TTYs using ASNI color escapes
42+
html-hljs: output in HTML format annotated with hljs classes
43+
html-lsp: output in HTML format annotated with LSP classes
4244
-i <p>, --image=<p> Reference the mach-o image at path
4345
by default, dump all classes in this image
4446
otherwise may specify --class or --protocol
@@ -47,4 +49,22 @@ Options:
4749
-j <N>, --jobs=<N> Allow N jobs at once
4850
only applicable when specified with -a/--dyld_shared_cache
4951
(defaults to number of processing core available)
52+
53+
--strip-protocol-conformance[=flag] Hide properties and methods that are required
54+
by a protocol the type conforms to
55+
(defaults to false)
56+
--strip-overrides[=flag] Hide properties and methods that are inherited
57+
from the class hierachy
58+
(defaults to false)
59+
--strip-duplicates[=flag] Hide duplicate occurrences of a property or method
60+
(defaults to false)
61+
--strip-synthesized[=flag] Hide methods and ivars that are synthesized from a property
62+
(defaults to true)
63+
--strip-ctor-method[=flag] Hide `.cxx_construct` method
64+
(defaults to false)
65+
--strip-dtor-method[=flag] Hide `.cxx_destruct` method
66+
(defaults to false)
67+
--add-symbol-comments[=flag] Add comments above each eligible declaration
68+
with the symbol name and image path the object is found in
69+
(defaults to false)
5070
```

Sources/classdumpctl/main.m

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ static void printUsage(const char *progname) {
5252
" -m <m>, --color=<m> Set color settings, one of the below\n"
5353
" default: color output using ASNI color escapes only if output is to a TTY\n"
5454
" never: no output is colored\n"
55-
" always: output to TTYs, pipes, and files are colored using ASNI color escapes\n"
56-
" html-hljs: output to TTYs, pipes, and files are in HTML format annotated with hljs classes\n"
57-
" html-lsp: output to TTYs, pipes, and files are in HTML format annotated with LSP classes\n"
55+
" always: color output to files, pipes, and TTYs using ASNI color escapes\n"
56+
" html-hljs: output in HTML format annotated with hljs classes\n"
57+
" html-lsp: output in HTML format annotated with LSP classes\n"
5858
" -i <p>, --image=<p> Reference the mach-o image at path\n"
5959
" by default, dump all classes in this image\n"
6060
" otherwise may specify --class or --protocol\n"
@@ -64,11 +64,11 @@ static void printUsage(const char *progname) {
6464
" only applicable when specified with -a/--dyld_shared_cache\n"
6565
" (defaults to number of processing core available)\n"
6666
"\n"
67-
" --strip-protocol-conformance[=flag] Hide properties and methods\n"
68-
" that are required by a protocol the type conforms to\n"
67+
" --strip-protocol-conformance[=flag] Hide properties and methods that are required\n"
68+
" by a protocol the type conforms to\n"
6969
" (defaults to false)\n"
70-
" --strip-overrides[=flag] Hide properties and methods\n"
71-
" that are inherited from the class hierachy\n"
70+
" --strip-overrides[=flag] Hide properties and methods that are inherited\n"
71+
" from the class hierachy\n"
7272
" (defaults to false)\n"
7373
" --strip-duplicates[=flag] Hide duplicate occurrences of a property or method\n"
7474
" (defaults to false)\n"

0 commit comments

Comments
 (0)