|
3 | 3 | `ozil` assists you with viewing man/help pages. It is intended as a
|
4 | 4 | porcelain for `man`/`--help` + `less`/`more`/`most`.
|
5 | 5 |
|
6 |
| -[Note: Support for man pages is not yet ready.] |
| 6 | +[Note: Support for man pages is not yet ready. If you try to read a man page, |
| 7 | +`ozil` might crash or display something weird.] |
7 | 8 |
|
8 | 9 | ## Table of contents
|
9 | 10 |
|
@@ -45,9 +46,11 @@ porcelain for `man`/`--help` + `less`/`more`/`most`.
|
45 | 46 |
|
46 | 47 | ### Planned
|
47 | 48 |
|
48 |
| -- Basic options to customize appearance (with hot-reloading). |
49 |
| -- Proper man page support (fill remain check-boxes in Feature list). |
50 |
| -- Search text (see [issue 10](https://github.com/theindigamer/ozil/issues/10)). |
| 49 | +- Proper man page support (fill remain check-boxes in Feature list). Given the |
| 50 | + variety of macros present in man pages, this is a big task, so please have |
| 51 | + some patience. :sweat_smile: |
| 52 | +- Basic options to customize appearance (with hot-reloading). |
| 53 | +- Search text (see [issue 10](https://github.com/theindigamer/ozil/issues/10)). |
51 | 54 |
|
52 | 55 | ## Platforms
|
53 | 56 |
|
@@ -83,7 +86,8 @@ see the help for `foo bar` (where `bar` is a subcommand of `foo`) run
|
83 | 86 | `ozil 'foo bar'`.
|
84 | 87 |
|
85 | 88 | If you're want a man page from a specific section (e.g. `man(1)`), you
|
86 |
| -can use `ozil man.1`. |
| 89 | +can use `ozil man.1` (Note: This might still crash as documented at the |
| 90 | +beginning of the Readme). |
87 | 91 |
|
88 | 92 | That's mostly it. `ozil` will guide you as needed. In case of
|
89 | 93 | ambiguities, it will present you with an option to make a choice and
|
|
0 commit comments