sfeed

simple feed reader - forked from git.codemadness.org/sfeed
git clone git://src.gearsix.net/sfeedsfeed.zip
Log | Files | Refs | Atom | README | LICENSE

sfeed_gopher.1 (raw) (1896B)


   1 .Dd May 14, 2022
   2 .Dt SFEED_GOPHER 1
   3 .Os
   4 .Sh NAME
   5 .Nm sfeed_gopher
   6 .Nd format feed data to Gopher files
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Op Ar
  10 .Sh DESCRIPTION
  11 .Nm
  12 formats feed data (TSV) from
  13 .Xr sfeed 1
  14 from stdin or for each
  15 .Ar file
  16 to stdout in the raw Gopher output format.
  17 .Pp
  18 If one or more
  19 .Ar file
  20 arguments are specified then the basename of the
  21 .Ar file
  22 is used as the feed name in the output.
  23 .Nm
  24 creates an index file named "index" and for each feed it creates a file with
  25 the same name as the basename of the feed
  26 .Ar file .
  27 .Pp
  28 If no
  29 .Ar file
  30 arguments are specified and so the data is read from stdin then the data is
  31 written to stdout and no files are written.
  32 .Pp
  33 Items with a timestamp from the last day compared to the system time at the
  34 time of formatting are counted and marked as new.
  35 This value might be overridden through environment variables.
  36 Items are marked as new with the prefix "N" at the start of the line.
  37 .Sh ENVIRONMENT
  38 .Bl -tag -width Ds
  39 .It Ev SFEED_GOPHER_PATH
  40 This environment variable can be used as the prefix for each path in the
  41 index file.
  42 The default is "/".
  43 .It Ev SFEED_GOPHER_HOST
  44 This environment variable can be used as the Gopher Host field.
  45 The default is "127.0.0.1".
  46 .It Ev SFEED_GOPHER_PORT
  47 This environment variable can be used as the Gopher Port field.
  48 The default is "70".
  49 .It Ev SFEED_NEW_AGE
  50 Overwrite the maximum age in seconds to mark feeds as new.
  51 By default this is 86400, which equals one day.
  52 .El
  53 .Sh EXIT STATUS
  54 .Ex -std
  55 .Sh EXAMPLES
  56 .Bd -literal
  57 SFEED_GOPHER_HOST="codemadness.org" SFEED_GOPHER_PATH="/feeds/" \e
  58 	sfeed_gopher ~/.sfeed/feeds/*
  59 .Ed
  60 .Sh SEE ALSO
  61 .Xr sfeed 1 ,
  62 .Xr sfeed 5
  63 .Sh STANDARDS
  64 .Rs
  65 .%D March 1993
  66 .%R RFC 1436
  67 .%T The Internet Gopher Protocol
  68 .Re
  69 .Sh AUTHORS
  70 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
  71 .Sh CAVEATS
  72 The common-used 'h' and 'i' types are used in this program.
  73 These types are an extension to Gopher.