nojhan/tunnelmon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update README

Browse source
This commit is contained in:
Johann Dreo 2023-07-20 11:17:53 +02:00
commit 2186d32e60
1 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -5,12 +5,12 @@ tunnelmon -- Monitor and manage autoSSH tunnels
`tunnelmon` [-h] `tunnelmon` [-h]
`tunnelmon` [-c] [-n] [-u] [-l LEVEL] [-g FILE] `tunnelmon` [-c] [-n] [-u] [-l LEVEL] [-g FILE] [-s]
## DESCRIPTION ## DESCRIPTION
`tunnelmon` is an autossh tunnel monitor. It gives a user interface to monitor existing SSH tunnel, and tunnels managed with autossh. `tunnelmon` is an autossh tunnel monitor. It gives a user interface to monitor existing SSH tunnel, and tunnels managed with autossh.
It can print the current state of your tunnels or display them in an interactive text-based interface. It can print the current state of your tunnels or display them in an interactive text-based interface.
@ -55,6 +55,9 @@ Called without option,`tunnelmon` will print the current state of the autossh tu
Log messages are written to the given FILE. Useful to debug the interactive interface. Log messages are written to the given FILE. Useful to debug the interactive interface.
If not set, asking for the curses interface automatically set logging to the "tunnelmon.log" file. If not set, asking for the curses interface automatically set logging to the "tunnelmon.log" file.
* `-s`, `--log-sensitive`:
Allow sensitive information (hostnames, IPs, PIDs, etc.) into the logs.
## INTERACTIVE INTERFACE ## INTERACTIVE INTERFACE
@ -64,7 +67,7 @@ Keyboard commands:
* `R`: Reload the selected autossh instance (i.e. send a `SIGUSR1`, which is interpreted as a reload command by autossh). * `R`: Reload the selected autossh instance (i.e. send a `SIGUSR1`, which is interpreted as a reload command by autossh).
* `C`: Close the selected tunnel (i.e. send a `SIGTERM`). * `C`: Close the selected tunnel (i.e. send a `SIGTERM`).
* `N`: Show the network connections related to each tunnel instances. * `N`: Show the network connections related to each tunnel instances.
* `Q`: Quit tunnelmon. * `Q`: Quit Tunnelmon.
## DISPLAY ## DISPLAY