From d3b19877ad59ad15df8df8718e6afd481636dfd2 Mon Sep 17 00:00:00 2001 From: Hiltjo Posthuma <hiltjo@codemadness.org> Date: Sat, 3 Jan 2015 17:23:32 +0100 Subject: man: add sfeed_stats.1 --- Makefile | 1 + TODO | 2 +- doc/html/sfeed_stats.1.html | 64 +++++++++++++++++++++++++++++++++++++++++++++ doc/man/sfeed_stats.1 | 22 ++++++++++++++++ sfeed_stats.1 | 21 +++++++++++++++ 5 files changed, 109 insertions(+), 1 deletion(-) create mode 100644 doc/html/sfeed_stats.1.html create mode 100644 doc/man/sfeed_stats.1 create mode 100644 sfeed_stats.1 diff --git a/Makefile b/Makefile index 0ab9d8f..60e5fcf 100644 --- a/Makefile +++ b/Makefile @@ -34,6 +34,7 @@ MAN1 = \ sfeed_opml_export.1\ sfeed_opml_import.1\ sfeed_plain.1\ + sfeed_stats.1\ sfeed_update.1\ sfeed_web.1\ sfeed_xmlenc.1 diff --git a/TODO b/TODO index f0ff074..b07359d 100644 --- a/TODO +++ b/TODO @@ -1,5 +1,5 @@ [ ] grep -H -n *.c 'TODO:' -[ ] sfeed_stats: add man page. +[x] sfeed_stats: add man page. [ ] sfeed_frame: snprintf check truncated, <= 0 and >= size. [ ] sfeed.c: document ctx.iscontent and ctx.iscontenttag. [ ] use openbsd sys/queue.h for util.c linked-list and sfeed_frames.c diff --git a/doc/html/sfeed_stats.1.html b/doc/html/sfeed_stats.1.html new file mode 100644 index 0000000..285454d --- /dev/null +++ b/doc/html/sfeed_stats.1.html @@ -0,0 +1,64 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<meta name="resource-type" content="document"> +<link rel="stylesheet" href="man.css" type="text/css" media="all"> +<title> +SFEED_STATS(1)</title> +</head> +<body> +<div class="mandoc"> +<table summary="Document Header" class="head" width="100%"> +<col width="30%"> +<col width="30%"> +<col width="30%"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED_STATS(1)</td> +<td class="head-vol" align="center"> +OpenBSD Reference Manual</td> +<td class="head-rtitle" align="right"> +SFEED_STATS(1)</td> +</tr> +</tbody> +</table> +<div class="section"> +<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed_stats</b> — <span class="desc">formats a feeds file to show a plain text summary</span></div> +<div class="section"> +<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis"> +<col style="width: 11.00ex;"> +<col> +<tbody> +<tr> +<td> +sfeed_stats</td> +<td> +</td> +</tr> +</tbody> +</table> +</div> +<div class="section"> +<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed_stats</b> formats a feeds file (TSV) from <a class="link-man">sfeed_update(1)</a> to a plain text summary with: the total amount of items, amount of new items, the timestamp of the last item. It reads TSV data from stdin and writes formatted plain text to stdout. For the exact TSV format see <a class="link-man">sfeed_update(1)</a>.</div> +<div class="section"> +<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sfeed_update(1)</a>, <a class="link-man">sfeed(1)</a></div> +<div class="section"> +<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></div> +<table summary="Document Footer" class="foot" width="100%"> +<col width="50%"> +<col width="50%"> +<tbody> +<tr> +<td class="foot-date"> +January 3, 2015</td> +<td class="foot-os" align="right"> +</td> +</tr> +</tbody> +</table> +</div> +</body> +</html> + diff --git a/doc/man/sfeed_stats.1 b/doc/man/sfeed_stats.1 new file mode 100644 index 0000000..2941501 --- /dev/null +++ b/doc/man/sfeed_stats.1 @@ -0,0 +1,22 @@ +.TH "SFEED_STATS" "1" "January 3, 2015" "" "OpenBSD Reference Manual" +.nh +.if n .ad l +.SH "NAME" +\fBsfeed_stats\fR +\- formats a feeds file to show a plain text summary +.SH "SYNOPSIS" +.HP 12n +\fBsfeed_stats\fR +.SH "DESCRIPTION" +\fBsfeed_stats\fR +formats a feeds file (TSV) from +sfeed_update(1) +to a plain text summary with: the total amount of items, amount of new items, +the timestamp of the last item. It reads TSV data from stdin and writes +formatted plain text to stdout. For the exact TSV format see +sfeed_update(1). +.SH "SEE ALSO" +sfeed_update(1), +sfeed(1) +.SH "AUTHORS" +Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/sfeed_stats.1 b/sfeed_stats.1 new file mode 100644 index 0000000..b72e442 --- /dev/null +++ b/sfeed_stats.1 @@ -0,0 +1,21 @@ +.Dd January 3, 2015 +.Dt SFEED_STATS 1 +.Os +.Sh NAME +.Nm sfeed_stats +.Nd formats a feeds file to show a plain text summary +.Sh SYNOPSIS +.Nm sfeed_stats +.Sh DESCRIPTION +.Nm +formats a feeds file (TSV) from +.Xr sfeed_update 1 +to a plain text summary with: the total amount of items, amount of new items, +the timestamp of the last item. It reads TSV data from stdin and writes +formatted plain text to stdout. For the exact TSV format see +.Xr sfeed_update 1 . +.Sh SEE ALSO +.Xr sfeed_update 1 , +.Xr sfeed 1 +.Sh AUTHORS +.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org -- cgit v1.2.3