Skip to content

added man page for nm-hotspot and updated Makefile #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HiddenKeyDev merged 1 commit into from
Oct 12, 2025
Merged

added man page for nm-hotspot and updated Makefile #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@ test:
@command -v shellcheck >/dev/null 2>&1 || { echo "shellcheck not installed"; exit 1; }
shellcheck src/nm-hotspot scripts/*.sh
@echo "All checks passed"

install-man:
install -Dm644 docs/nm-hotspot.1 /usr/share/man/man1/nm-hotspot.1
76 changes: 76 additions & 0 deletions docs/nm-hotspot.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
.TH NM-HOTSPOT 1 "October 2025" "nm-hotspot-cli 1.0" "User Commands"
.SH NAME
nm-hotspot \- Simple CLI tool to manage Wi-Fi hotspots using NetworkManager
.SH SYNOPSIS
.B nm-hotspot
[\fICOMMAND\fR] [\fIOPTIONS\fR]
.SH DESCRIPTION
nm-hotspot is a command-line tool that allows users to quickly create and manage secure Wi-Fi hotspots using NetworkManager.
.SH COMMANDS
.TP
.B help
Show help information.
.TP
.B create
Create a hotspot with optional SSID, password, band, and save options.
.TP
.B start
Start the saved hotspot configuration.
.TP
.B stop
Stop the active hotspot.
.TP
.B status
Display current hotspot status.
.TP
.B list
List available wireless devices.
.TP
.B config
Display saved configuration.
.TP
.B log
Show or manage logs.
.TP
.BR log " --tail \fIN\fR"
Show last N log entries (default: 20).
.TP
.BR log " --clear"
Clear the log file.
.SH OPTIONS (for \fBcreate\fR)
.TP
.B -s, --ssid \fISSID\fR
Set the hotspot name (default: MyHotspot).
.TP
.B -p, --password \fIPASS\fR
Set WPA2 password (min 8 chars; default: 12345678).
.TP
.B -b, --band \fIBAND\fR
Set band: bg (2.4GHz) or a (5GHz) (default: bg).
.TP
.B --save
Save the current configuration.
.SH EXAMPLES
.TP
Create a hotspot with default settings:
.B nm-hotspot create
.TP
Create a 5GHz hotspot:
.B nm-hotspot create -s "Coffee-Shop" -p "Secure1234" -b a
.TP
Start saved hotspot:
.B nm-hotspot start
.TP
Check hotspot status:
.B nm-hotspot status
.SH FILES
.TP
.B ~/.config/nm-hotspot/hotspot.conf
Configuration file for default settings.
.TP
.B ~/.config/nm-hotspot/nm-hotspot.log
Log file.
.SH AUTHOR
HiddenKeyDev
.SH SEE ALSO
.B nmcli(1)