.\" Text automatically generated by txt2man
.TH ots 1 "2020-07-10" "ots-1.0" "Summarizes Texts"
.SH NAME
\fBots \fP- Open Text Summarizer
\fB
.SH SYNOPSIS
.nf
.fam C
\fBots\fP [\fIOPTIONS\fP] [file.txt | \fIstdin\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
The Open Text Summarizer is an open source tool for summarizing texts. The program reads a text and decides which sentences are important and which are not. OTS will create a short summary or will highlight the main ideas in the text.
.PP
OTS is both a library and a command line tool. Word processors such as AbiWord and KWord can link to the library and summarize documents while the command line tool lets you summarize text on the console. The program can either print the summarized text as text or HTML. If in HTML, the important sentences are highlighted. 
.SH OPTIONS
.TP
.B
-?, \fB--help\fP
Show help options.
.TP
.B
\fB-v\fP, \fB--version\fP
Show version information.
.TP
.B
\fB-r\fP, \fB--ratio\fP=INT
Summarization INT % [default = 20%].
.TP
.B
\fB-o\fP, \fB--out\fP=FILE
Output FILE [default = stdout].
.TP
.B
\fB-a\fP, \fB--about\fP
Only output the summary.
.TP
.B
\fB-h\fP, \fB--html\fP
Output as html.
.SH EXAMPLES
Summarize the article from the Sacramento Bee and highlight the 20% of sentences most important to the content of the article:
.PP
.nf
.fam C
        $ ots --ratio 20 --html articles/sacbee1.txt

.fam T
.fi
Print sentences most important of the article:
.PP
.nf
.fam C
        $ ots -a big_article.txt

.fam T
.fi
.SH AUTHORS
\fBots\fP was written by Nadav Rotem <nadav256@hotmail.com>.
.PP
This manual page was written by Luis Paulo Linares <lpfllinares@gmail.com> for the Debian project (but may be used by others).