80 lines
1.7 KiB
Groff
80 lines
1.7 KiB
Groff
|
.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>
|