xaizek / zograscope (License: AGPLv3 only) (since 2018-12-07)
Mainly a syntax-aware diff that also provides a number of additional tools.
<root> / docs / zs-hi.md (9b8c06f197e6b14c6b062b803112f02e114668d3) (927B) (mode 100644) [raw]
NAME
====

*zs-hi* is a primitive code highlighter for terminal.  The main purpose is
testing and debugging of code parsing, but it can also be used on its own.

The only hard-coded color scheme at the moment is for xterm-256color palette.

INVOCATION
==========

`zs-hi` `[options...]` _[{path|-}]_

Not providing _path_ argument is equivalent to specifying `-` and thus reading
from standard input.

EXAMPLES
========

Highlighting standard input
---------------------------

```
pahole -C key_chunk_t vifm | zs-hi
```

Highlighting a file
-------------------

```
zs-hi utils.c
```

Checking if code parses correctly
---------------------------------

Whether the parser is able to handle given sources can be checked like this:

```
find -name '*.[hc]' -exec zs-hi --dry {} \;
```

It produces output for files with which it has issues.

SEE ALSO
========

**zograscope**(7) for common options and list of all tools there.
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/zograscope

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/zograscope

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master