Add comprehensive man pages for C implementation tools

- Added man/wssshc.1: Complete manual page for WebSocket SSH client
- Added man/wsssh.1: Complete manual page for SSH wrapper
- Added man/wsscp.1: Complete manual page for SCP wrapper
- Updated Makefile to install man pages during 'make install'
- Updated Debian packaging to include man pages in .deb package
- Updated .gitignore to exclude compressed man pages
- Updated clean.sh to clean man page artifacts
- Updated documentation to mention man pages
- Updated CHANGELOG.md with man page additions

All man pages follow standard troff format with:
- SYNOPSIS, DESCRIPTION, OPTIONS sections
- EXAMPLES and SEE ALSO references
- Proper licensing and author information
- Comprehensive command-line option documentation
parent a9c261ad
......@@ -10,6 +10,7 @@ wssshtools/wsssh
wssshtools/wsscp
wssshtools/Makefile
wssshtools/configure.sh.stamp
wssshtools/man/*.1.gz
# Debian packaging artifacts
wssshtools/debian/wsssh-tools/
......
......@@ -32,6 +32,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `--debian` flag for Debian package creation
- Automatic C tool building when `wssshtools/` exists
- Comprehensive cleanup of all build artifacts
- **Man Pages**: Comprehensive documentation for C tools
- `wssshc(1)`: WebSocket SSH client registration
- `wsssh(1)`: SSH wrapper with tunneling
- `wsscp(1)`: SCP wrapper with tunneling
- Professional troff-formatted manual pages
- **Web Interface Enhancements**: Professional admin panel improvements
- Donation button in navigation bar
- Responsive modal design
......
......@@ -528,6 +528,7 @@ wsssh/
- **Make**: GNU Make build system
- **OpenSSL**: SSL/TLS library (libssl-dev)
- **pkg-config**: Build configuration tool
- **Man Pages**: Comprehensive documentation (man)
#### Debian Packaging
- **debhelper**: Debian packaging helper
......
......@@ -116,6 +116,14 @@ make
sudo make install
```
The C tools include comprehensive man pages:
```bash
man wssshc # WebSocket SSH client
man wsssh # SSH wrapper
man wsscp # SCP wrapper
```
## Quick Start
### 1. Start the WebSocket Daemon
......
......@@ -10,6 +10,7 @@ if [ -d "wssshtools" ]; then
cd wssshtools
make clean 2>/dev/null || true
rm -f configure.sh.stamp
rm -f man/*.1.gz 2>/dev/null || true
cd ..
fi
......
......@@ -24,6 +24,7 @@ override_dh_auto_build:
override_dh_auto_install:
make install DESTDIR=debian/wsssh-tools
dh_installman man/*.1
override_dh_auto_clean:
make clean
......
.TH WSSCP 1 "September 2024" "wsssh-tools 1.1.0" "WebSocket SSH Tools"
.SH NAME
wsscp \- WebSocket SCP wrapper for secure file transfer
.SH SYNOPSIS
.B wsscp
[\fB\-\-local\-port\fR \fIPORT\fR]
[\fB\-\-debug\fR]
[\fB\-\-help\fR]
[\fISCP_OPTIONS\fR...]
\fISOURCE\fR...
\fIDESTINATION\fR
.SH DESCRIPTION
.B wsscp
is a wrapper around the standard SCP client that enables secure file transfer through WebSocket connections. It automatically establishes tunnels to registered clients and handles file transfers transparently.
.SH OPTIONS
.TP
.BR \-\-local\-port " \fIPORT\fR"
Local port for tunnel establishment (default: auto-assign)
.TP
.B \-\-debug
Enable debug output for troubleshooting
.TP
.B \-\-help
Display help message and exit
.SH HOSTNAME FORMAT
Hostnames in source/destination paths follow the format: [\fIuser\fR@]\fIclient_id\fR.\fIwssshd_host\fR[:\fIport\fR]
.TP
Examples:
- \fBuser@remote.example.com:/path/file\fR → client: \fBremote\fR, server: \fBexample.com:22\fR
- \fBserver.datacenter.com:9898/file\fR → client: \fBserver\fR, server: \fBdatacenter.com:9898\fR
.SH EXAMPLES
.TP
Copy file to remote:
.B wsscp -P 9898 localfile user@myclient.example.com:/remote/path/
.TP
Copy file from remote:
.B wsscp -P 9898 user@myclient.example.com:/remote/file ./localfile
.TP
Copy directory recursively:
.B wsscp -P 9898 -r localdir user@myclient.example.com:/remote/
.TP
Copy with debug output:
.B wsscp --debug -P 2222 file.txt user@remote.example.com:~/downloads/
.SH SCP OPTIONS
All standard SCP options are supported. The port option (\fB-P\fR) specifies the wssshd server port, not the target SSH port.
.SH ENVIRONMENT
.TP
.B WSSCP_DEBUG
Set to 1 to enable debug output (alternative to --debug)
.SH SECURITY
File transfers are secured through SSL/TLS encrypted WebSocket tunnels. All data in transit is protected by the tunnel encryption.
.SH EXIT STATUS
.B wsscp
returns the exit status of the underlying SCP command.
.SH SEE ALSO
.BR scp (1),
.BR wssshd (1),
.BR wssshc (1),
.BR wsssh (1)
.SH AUTHOR
Written by Stefy Lanza <stefy@nexlab.net>
.SH COPYRIGHT
Copyright \(co 2024 Stefy Lanza and SexHack.me. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.SH BUGS
Report bugs to: https://github.com/stefy/wsssh/issues
\ No newline at end of file
.TH WSSH 1 "September 2024" "wsssh-tools 1.1.0" "WebSocket SSH Tools"
.SH NAME
wsssh \- WebSocket SSH wrapper for secure tunneling
.SH SYNOPSIS
.B wsssh
[\fB\-\-local\-port\fR \fIPORT\fR]
[\fB\-\-debug\fR]
[\fB\-\-help\fR]
\fIuser\fR@\fIclient\fR.\fIdomain\fR
[\fISSH_OPTIONS\fR...]
.SH DESCRIPTION
.B wsssh
is a wrapper around the standard SSH client that enables secure tunneling through WebSocket connections. It automatically parses hostnames to extract client IDs and server endpoints, establishes WebSocket tunnels, and launches SSH to connect through the tunnel.
.SH OPTIONS
.TP
.BR \-\-local\-port " \fIPORT\fR"
Local port for tunnel establishment (default: auto-assign)
.TP
.B \-\-debug
Enable debug output for troubleshooting
.TP
.B \-\-help
Display help message and exit
.SH HOSTNAME FORMAT
The hostname follows the format: \fIclient_id\fR.\fIwssshd_host\fR[:\fIport\fR]
.TP
Examples:
- \fBremote.example.com\fR → client: \fBremote\fR, server: \fBexample.com:22\fR
- \fBserver.datacenter.com:9898\fR → client: \fBserver\fR, server: \fBdatacenter.com:9898\fR
.SH EXAMPLES
.TP
Basic SSH connection:
.B wsssh user@myclient.example.com -p 9898
.TP
SSH with custom options:
.B wsssh -p 9898 -i ~/.ssh/key user@myclient.example.com ls -la
.TP
SSH with debug output:
.B wsssh --debug user@remote.example.com -p 2222
.SH ENVIRONMENT
.TP
.B WSSSH_DEBUG
Set to 1 to enable debug output (alternative to --debug)
.SH SECURITY
All tunnel communications are encrypted using SSL/TLS. The client verifies server certificates. For production deployments, use properly signed certificates.
.SH EXIT STATUS
.B wsssh
returns the exit status of the underlying SSH command.
.SH SEE ALSO
.BR ssh (1),
.BR wssshd (1),
.BR wssshc (1),
.BR wsscp (1)
.SH AUTHOR
Written by Stefy Lanza <stefy@nexlab.net>
.SH COPYRIGHT
Copyright \(co 2024 Stefy Lanza and SexHack.me. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.SH BUGS
Report bugs to: https://github.com/stefy/wsssh/issues
\ No newline at end of file
.TH WSSHc 1 "September 2024" "wsssh-tools 1.1.0" "WebSocket SSH Tools"
.SH NAME
wssshc \- WebSocket SSH Client for registration
.SH SYNOPSIS
.B wssshc
[\fB\-\-server\-ip\fR \fIIP\fR]
[\fB\-\-port\fR \fIPORT\fR]
[\fB\-\-id\fR \fIID\fR]
[\fB\-\-password\fR \fIPASSWORD\fR]
[\fB\-\-interval\fR \fISECONDS\fR]
[\fB\-\-debug\fR]
[\fB\-\-help\fR]
.SH DESCRIPTION
.B wssshc
is a lightweight client for registering machines with a WebSocket SSH daemon (wssshd). It establishes a persistent WebSocket connection and maintains registration with the server, allowing SSH/SCP tunneling through the registered machine.
.SH OPTIONS
.TP
.BR \-\-server\-ip " \fIIP\fR"
IP address of the wssshd server (required)
.TP
.BR \-\-port " \fIPORT\fR"
Port number of the wssshd server (default: 9898)
.TP
.BR \-\-id " \fIID\fR"
Unique client identifier for registration (required)
.TP
.BR \-\-password " \fIPASSWORD\fR"
Registration password for authentication (required)
.TP
.BR \-\-interval " \fISECONDS\fR"
Reconnection interval in seconds if connection is lost (default: 30)
.TP
.B \-\-debug
Enable debug output for troubleshooting
.TP
.B \-\-help
Display help message and exit
.SH EXAMPLES
.TP
Register a client machine:
.B wssshc --server-ip 192.168.1.100 --port 9898 --id workstation01 --password mysecret
.TP
Register with debug output:
.B wssshc --server-ip server.example.com --id laptop01 --password secret --debug
.SH SECURITY
All communications are encrypted using SSL/TLS. The client uses self-signed certificates by default. For production use, ensure proper certificate validation.
.SH SEE ALSO
.BR wssshd (1),
.BR wsssh (1),
.BR wsscp (1)
.SH AUTHOR
Written by Stefy Lanza <stefy@nexlab.net>
.SH COPYRIGHT
Copyright \(co 2024 Stefy Lanza and SexHack.me. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.SH BUGS
Report bugs to: https://github.com/stefy/wsssh/issues
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment