69 lines
1.4 KiB
Groff
69 lines
1.4 KiB
Groff
|
.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>
|