Files
skitter/skitter/usage.py

64 lines
2.1 KiB
Python

#!/usr/bin/env python3
"help page"
from os import getenv
def print_help():
"""print help"""
NAME = "skitter"
VERSION = "0.0.0"
BANNER = '''\x1b[34m
▗▖ █ ▄
▐▌ ▀ ▐▌ ▐▌ █
▗▟██▖▐▌▟▛ ██ ▐███ ▐███ ▟█▙ █▟█▌ █
▐▙▄▖▘▐▙█ █ ▐▌ ▐▌ ▐▙▄▟▌ █▘ █
▀▀█▖▐▛█▖ █ ▐▌ ▐▌ ▐▛▀▀▘ █ ▀
▐▄▄▟▌▐▌▝▙ ▗▄█▄▖ ▐▙▄ ▐▙▄ ▝█▄▄▌ █ ▄
▀▀▀ ▝▘ ▀▘▝▀▀▀▘ ▀▀ ▀▀ ▝▀▀ ▀ ▀
\x1b[0m'''
USAGE = f'''
Rapidly sweep through many radio channels and record interesting activity.
SYNOPSIS
{NAME} [--band=|-b FREQ] [--out-directory=|-o DIR] [--squelch=|-s LEVEL] [--rate=|-r SPEED]
{NAME} [--help|-h]
--band
-b
Desired frequencies (list) to scan.
Skitter will sweep through these frequencies at a set rate.
--out-directory
-o
Output directory. Default: ./
Skitter will save its recordings in a single directory.
You might want to create a new directory for recordings.
--squelch
-s
Level at which to start listening, in decibels (dB).
Anything below this level will be ignored.
--rate
-r
Delay (in milliseconds) between changing channels.
Increase if your receiver cannot switch frequencies
quickly enough.
Default: UNSET
--help
-h
Print this message and exit.
EXAMPLES
{NAME} -r 300
Sweep through default range and change channels every 300 milliseconds.
{NAME} -o ~/Music/
Run with all default settings and send files to {getenv("HOME")}/Music
'''
print(BANNER)
print(f"skitter v\x1b[33m{VERSION}\x1b[0m")
print(USAGE)