enoch/n2n
1
0
Fork 0
mirror of https://github.com/ntop/n2n.git synced 2024-09-19 16:41:11 +02:00
Code Issues Actions Packages Projects Releases 1 Wiki Activity

Clearly separate documented scripts into user and build categories

Browse Source
This commit is contained in:
Hamish Coleman 2021-11-01 10:30:38 +00:00
parent 0d04b40926
commit d57ac3c6a1
1 changed files with 24 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/Scripts.md
View File

@ -5,25 +5,13 @@ Some of these scripts are only useful during build and development, but
other scripts are intended for end users to be able to use. These scripts
may be installed with n2n as part of your operating system package.
All scripts can be found in the `scripts` directory.
Short descriptions of these scripts are below.
## `scripts/hack_fakeautoconf.sh`
## End user scripts
This shell script is used during development to help build on Windows
systems. An example of how to use it is shown in
the [Building document](Building.md)
## `scripts/indent.sh`
This shell script is a wrapper for the `uncrustify` C code style checker
which checks or applies a set of rules to the code. It is used during
the automated lint checks.
## `scripts/test_harness.sh`
This shell script is used to run automated tests during development.
## `scripts/n2n-ctl`
### `n2n-ctl`
This python script provides an easy command line interface to the running
n2n processes. It uses UDP communications to talk to the Management API.
@ -34,7 +22,7 @@ Example:
- `scripts/n2n-ctl --help`
- `scripts/n2n-ctl help`
## `scripts/n2n-httpd`
### `n2n-httpd`
This python script is a simple http gateway to the running edge. It provides
a proxy for REST-like HTTP requests to talk to the Management API.
@ -49,7 +37,25 @@ Example:
- `scripts/n2n-httpd --help`
- `scripts/n2n-httpd 8087`
## `scripts/n2n-gateway.sh`
## Build and Development scripts
### `hack_fakeautoconf.sh`
This shell script is used during development to help build on Windows
systems. An example of how to use it is shown in
the [Building document](Building.md)
### `indent.sh`
This shell script is a wrapper for the `uncrustify` C code style checker
which checks or applies a set of rules to the code. It is used during
the automated lint checks.
### `test_harness.sh`
This shell script is used to run automated tests during development.
### `n2n-gateway.sh`
A sample script to route all the host traffic towards a remote gateway,
which is reachable via the n2n virtual interface.