man page improvements - sfeed_curses - sfeed curses UI (now part of sfeed, development is in sfeed)
 (HTM) git clone git://git.codemadness.org/sfeed_curses
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
 (DIR) commit a3c02678f80ec8c253ce680d36ae9bd4ee935d8c
 (DIR) parent fc93b4fee3ca1aa3430458e848d2f37ff010074d
 (HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
       Date:   Sat, 24 Jul 2021 22:56:59 +0200
       
       man page improvements
       
       Diffstat:
         M sfeed_content.1                     |      46 +++++++++++++++++++++++++++----
         M sfeed_curses.1                      |       4 ++--
         M sfeed_markread.1                    |      24 +++++++++++++++++++++---
       
       3 files changed, 63 insertions(+), 11 deletions(-)
       ---
 (DIR) diff --git a/sfeed_content.1 b/sfeed_content.1
       @@ -1,4 +1,4 @@
       -.Dd October 24, 2020
       +.Dd July 25, 2021
        .Dt SFEED_CONTENT 1
        .Os
        .Sh NAME
       @@ -6,17 +6,51 @@
        .Nd view RSS/Atom content
        .Sh SYNOPSIS
        .Nm
       +.Op Ar
        .Sh DESCRIPTION
        .Nm
       -expects to receive a TSV line from stdin in the
       -.Xr sfeed 5
       -format.
       -By default it will format the data to a readable plain-text format and use the
       -pager.
       +formats feed data (TSV) from
       +.Xr sfeed 1
       +from stdin or for each
       +.Ar file
       +to stdout as plain-text content.
       +For HTML content it uses
       +.Xr lynx 1
       +to convert it to plain-text.
       +At the end it uses the pager to view the output.
       +The
       +.Nm
       +script can be used by
       +.Xr sfeed_curses 1
       +to view content.
       +.Sh ENVIRONMENT VARIABLES
       +.Bl -tag -width Ds
       +.It Ev PAGER
       +The pager used to view the content.
       +If it is not set it will use "less -R" by default.
       +.El
        .Sh EXIT STATUS
        .Ex -std
       +.Sh EXAMPLES
       +.Bd -literal
       +curl -s 'https://codemadness.org/atom_content.xml' | sfeed | sfeed_content
       +.Ed
       +.Pp
       +The output format looks like this:
       +.Bd -literal
       +Title:     The title.
       +Author:    The line with the author if it is set.
       +Category:  The line with the categories if it is set.
       +Link:      The line with the link if it is set.
       +Enclosure: The line with the enclosure if it is set.
       +
       +The content converted to plain-text.
       +
       +<form feed character> if there are multiple items.
       +.Ed
        .Sh SEE ALSO
        .Xr awk 1 ,
       +.Xr less 1 ,
        .Xr lynx 1 ,
        .Xr sfeed_curses 1
        .Sh AUTHORS
 (DIR) diff --git a/sfeed_curses.1 b/sfeed_curses.1
       @@ -1,4 +1,4 @@
       -.Dd July 22, 2021
       +.Dd July 24, 2021
        .Dt SFEED_CURSES 1
        .Os
        .Sh NAME
       @@ -6,7 +6,7 @@
        .Nd curses UI for viewing feed items
        .Sh SYNOPSIS
        .Nm
       -.Op Ar file...
       +.Op Ar
        .Sh DESCRIPTION
        .Nm
        shows the feed data which is in the
 (DIR) diff --git a/sfeed_markread.1 b/sfeed_markread.1
       @@ -1,4 +1,4 @@
       -.Dd July 16, 2021
       +.Dd July 25, 2021
        .Dt SFEED_MARKREAD 1
        .Os
        .Sh NAME
       @@ -7,21 +7,39 @@
        .Sh SYNOPSIS
        .Nm
        .Ar read | Ar unread
       +.Op Ar urlfile
        .Sh DESCRIPTION
        .Nm
        reads a plain-text list of URLs from stdin.
        The file format for the list of URLs is one URL per line.
        .Nm
       -will write to the file specified in the environment variable
       +will write to the file specified as
       +.Ar urlfile
       +or with the environment variable
        .Ev SFEED_URL_FILE .
       +The
       +.Nm
       +script can be used by
       +.Xr sfeed_curses 1
       +to mark items as read and unread.
        .Sh ENVIRONMENT VARIABLES
        .Bl -tag -width Ds
        .It Ev SFEED_URL_FILE
       -This variable must be set to use as the path to the file containing a
       +This variable can be set to use as the path to the file containing a
        plain-text list of read URLs.
        .El
        .Sh EXIT STATUS
        .Ex -std
       +.Sh EXAMPLES
       +.Bd -literal
       +export SFEED_URL_FILE="$HOME/.sfeed/urls"
       +echo 'https://codemadness.org/sfeed.html' | sfeed_markread read
       +.Ed
       +.Pp
       +or
       +.Bd -literal
       +echo 'https://codemadness.org/sfeed.html' | sfeed_markread read ~/.sfeed/urls
       +.Ed
        .Sh SEE ALSO
        .Xr awk 1 ,
        .Xr sfeed_curses 1