Update.
This commit is contained in:
@@ -0,0 +1,80 @@
|
||||
.TH TIKKER-AGGREGATOR 1 "2024-11-28" "Tikker 2.0" "User Commands"
|
||||
.SH NAME
|
||||
tikker-aggregator \- generate keystroke statistics and summaries
|
||||
.SH SYNOPSIS
|
||||
.B tikker-aggregator
|
||||
[\fIOPTIONS\fR]
|
||||
.SH DESCRIPTION
|
||||
Aggregates keystroke data into statistical summaries. Provides daily, hourly,
|
||||
weekly, and weekday breakdowns. Supports multiple output formats.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B --daily
|
||||
Generate daily statistics
|
||||
.TP
|
||||
.B --hourly <date>
|
||||
Generate hourly stats for specific date (YYYY-MM-DD format)
|
||||
.TP
|
||||
.B --weekly
|
||||
Generate weekly statistics
|
||||
.TP
|
||||
.B --weekday
|
||||
Generate weekday comparison statistics
|
||||
.TP
|
||||
.B --top-keys [N]
|
||||
Show top N most pressed keys (default: 10)
|
||||
.TP
|
||||
.B --top-words [N]
|
||||
Show top N most typed words (default: 10)
|
||||
.TP
|
||||
.B --format <format>
|
||||
Output format: json, csv, text (default: text)
|
||||
.TP
|
||||
.B --output <file>
|
||||
Write output to file instead of stdout
|
||||
.TP
|
||||
.B --database <path>
|
||||
Use custom database file (default: tikker.db)
|
||||
.TP
|
||||
.B --help
|
||||
Display help message
|
||||
.SH EXAMPLES
|
||||
Generate daily statistics:
|
||||
.IP
|
||||
.B tikker-aggregator --daily
|
||||
.PP
|
||||
Generate hourly stats for specific date:
|
||||
.IP
|
||||
.B tikker-aggregator --hourly 2024-11-28
|
||||
.PP
|
||||
Generate weekly statistics in JSON format:
|
||||
.IP
|
||||
.B tikker-aggregator --weekly --format json --output weekly.json
|
||||
.PP
|
||||
Show weekday comparison:
|
||||
.IP
|
||||
.B tikker-aggregator --weekday
|
||||
.SH OUTPUT FIELDS
|
||||
.TP
|
||||
.B Daily Statistics
|
||||
Total Key Presses, Total Releases, Total Repeats, Total Events
|
||||
.TP
|
||||
.B Hourly Statistics
|
||||
Hour, Presses per hour
|
||||
.TP
|
||||
.B Weekly Statistics
|
||||
Day of week, Total presses
|
||||
.TP
|
||||
.B Weekday Statistics
|
||||
Weekday name, Total presses, Average per hour
|
||||
.SH EXIT STATUS
|
||||
.TP
|
||||
.B 0
|
||||
Success
|
||||
.TP
|
||||
.B 1
|
||||
Database error or invalid parameters
|
||||
.SH SEE ALSO
|
||||
tikker-decoder(1), tikker-indexer(1), tikker-report(1)
|
||||
.SH AUTHOR
|
||||
Retoor <retoor@molodetz.nl>
|
||||
@@ -0,0 +1,52 @@
|
||||
.TH TIKKER-DECODER 1 "2024-11-28" "Tikker 2.0" "User Commands"
|
||||
.SH NAME
|
||||
tikker-decoder \- decode keylogged data from token format to readable text
|
||||
.SH SYNOPSIS
|
||||
.B tikker-decoder
|
||||
[\fIOPTIONS\fR] \fI<input_file>\fR \fI<output_file>\fR
|
||||
.SH DESCRIPTION
|
||||
Converts keystroke token data into readable text format. Handles special keys
|
||||
like BACKSPACE, TAB, ENTER, and shift-modified characters.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B --verbose
|
||||
Show processing progress
|
||||
.TP
|
||||
.B --stats
|
||||
Print decoding statistics
|
||||
.TP
|
||||
.B --help
|
||||
Display help message
|
||||
.SH EXAMPLES
|
||||
Decode a single keylog file:
|
||||
.IP
|
||||
.B tikker-decoder logs_plain/2024-11-28.txt decoded.txt
|
||||
.PP
|
||||
With verbose output:
|
||||
.IP
|
||||
.B tikker-decoder --verbose logs_plain/2024-11-28.txt decoded.txt
|
||||
.SH INPUT FORMAT
|
||||
Input files should contain keystroke tokens in bracket notation:
|
||||
.IP
|
||||
[a][b][c] outputs "abc"
|
||||
.IP
|
||||
[LEFT_SHIFT][a] outputs "A"
|
||||
.IP
|
||||
[BACKSPACE] removes last character
|
||||
.IP
|
||||
[ENTER] outputs newline
|
||||
.IP
|
||||
[TAB] outputs tab character
|
||||
.SH OUTPUT
|
||||
Plain text file with decoded keystroke data
|
||||
.SH EXIT STATUS
|
||||
.TP
|
||||
.B 0
|
||||
Success
|
||||
.TP
|
||||
.B 1
|
||||
Input/output error or file not found
|
||||
.SH SEE ALSO
|
||||
tikker-indexer(1), tikker-aggregator(1), tikker-report(1)
|
||||
.SH AUTHOR
|
||||
Retoor <retoor@molodetz.nl>
|
||||
@@ -0,0 +1,68 @@
|
||||
.TH TIKKER-INDEXER 1 "2024-11-28" "Tikker 2.0" "User Commands"
|
||||
.SH NAME
|
||||
tikker-indexer \- build word index and analyze text frequency
|
||||
.SH SYNOPSIS
|
||||
.B tikker-indexer
|
||||
[\fIOPTIONS\fR]
|
||||
.SH DESCRIPTION
|
||||
Builds a searchable word index from text files. Provides frequency analysis,
|
||||
ranking, and top-N word retrieval. Uses SQLite for storage and fast queries.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B --index
|
||||
Build word index from logs_plain directory
|
||||
.TP
|
||||
.B --popular [N]
|
||||
Show top N most popular words (default: 10)
|
||||
.TP
|
||||
.B --find <word>
|
||||
Find frequency and rank of a specific word
|
||||
.TP
|
||||
.B --database <path>
|
||||
Use custom database file (default: tags.db)
|
||||
.TP
|
||||
.B --help
|
||||
Display help message
|
||||
.SH EXAMPLES
|
||||
Build the word index:
|
||||
.IP
|
||||
.B tikker-indexer --index
|
||||
.PP
|
||||
Show top 20 most popular words:
|
||||
.IP
|
||||
.B tikker-indexer --popular 20
|
||||
.PP
|
||||
Find frequency of a specific word:
|
||||
.IP
|
||||
.B tikker-indexer --find "function"
|
||||
.PP
|
||||
Use custom database:
|
||||
.IP
|
||||
.B tikker-indexer --database /tmp/words.db --popular 5
|
||||
.SH OUTPUT FORMAT
|
||||
Popular words output:
|
||||
.IP
|
||||
#<rank> <word> <count> <percentage>%
|
||||
.PP
|
||||
Find output:
|
||||
.IP
|
||||
Word: '<word>'
|
||||
.IP
|
||||
Rank: #<rank>
|
||||
.IP
|
||||
Frequency: <count>
|
||||
.SH NOTES
|
||||
\- Words less than 2 characters are ignored
|
||||
\- Case-insensitive matching
|
||||
\- Alphanumeric characters and underscores only
|
||||
.SH EXIT STATUS
|
||||
.TP
|
||||
.B 0
|
||||
Success
|
||||
.TP
|
||||
.B 1
|
||||
Error (database not found, no action specified)
|
||||
.SH SEE ALSO
|
||||
tikker-decoder(1), tikker-aggregator(1), tikker-report(1)
|
||||
.SH AUTHOR
|
||||
Retoor <retoor@molodetz.nl>
|
||||
@@ -0,0 +1,79 @@
|
||||
.TH TIKKER-REPORT 1 "2024-11-28" "Tikker 2.0" "User Commands"
|
||||
.SH NAME
|
||||
tikker-report \- generate HTML activity reports
|
||||
.SH SYNOPSIS
|
||||
.B tikker-report
|
||||
[\fIOPTIONS\fR]
|
||||
.SH DESCRIPTION
|
||||
Generates comprehensive HTML reports of keystroke activity. Can include
|
||||
embedded graphs and statistics summaries.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B --input <dir>
|
||||
Input logs directory (default: logs_plain)
|
||||
.TP
|
||||
.B --output <file>
|
||||
Output HTML file (default: report.html)
|
||||
.TP
|
||||
.B --graph-dir <dir>
|
||||
Directory containing PNG graphs to embed
|
||||
.TP
|
||||
.B --include-graphs
|
||||
Enable embedding of PNG graphs from graph-dir
|
||||
.TP
|
||||
.B --database <path>
|
||||
Use custom database file (default: tikker.db)
|
||||
.TP
|
||||
.B --title <title>
|
||||
Report title
|
||||
.TP
|
||||
.B --help
|
||||
Display help message
|
||||
.SH EXAMPLES
|
||||
Generate default HTML report:
|
||||
.IP
|
||||
.B tikker-report
|
||||
.PP
|
||||
Generate report with custom output file:
|
||||
.IP
|
||||
.B tikker-report --output activity-report.html
|
||||
.PP
|
||||
Generate report with embedded graphs:
|
||||
.IP
|
||||
.B tikker-report --include-graphs --graph-dir ./graphs --output report.html
|
||||
.PP
|
||||
Custom input directory:
|
||||
.IP
|
||||
.B tikker-report --input ./logs --output ./reports/activity.html
|
||||
.SH OUTPUT
|
||||
Generates an HTML file containing:
|
||||
\- Activity statistics (total presses, releases, repeats)
|
||||
\- Report generation timestamp
|
||||
\- Embedded PNG graphs (if enabled)
|
||||
\- Styled with dark theme for readability
|
||||
.SH HTML STRUCTURE
|
||||
.IP
|
||||
<html>
|
||||
.IP
|
||||
<head> - Embedded CSS styling
|
||||
.IP
|
||||
<body>
|
||||
.IP
|
||||
<h1> - Report title
|
||||
.IP
|
||||
<div class="stats"> - Statistics section
|
||||
.IP
|
||||
</body>
|
||||
.IP
|
||||
</html>
|
||||
.SH EXIT STATUS
|
||||
.TP
|
||||
.B 0
|
||||
Success
|
||||
.TP
|
||||
.B 1
|
||||
Database error, invalid parameters, or output file error
|
||||
.SH SEE ALSO
|
||||
tikker-decoder(1), tikker-indexer(1), tikker-aggregator(1)
|
||||
.SH AUTHOR
|
||||
Retoor <retoor@molodetz.nl>
|
||||
Reference in New Issue
Block a user