summaryrefslogtreecommitdiff
path: root/sfeed_gph.1
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2018-02-16 12:40:05 +0100
committerHiltjo Posthuma <hiltjo@codemadness.org>2018-02-16 12:40:05 +0100
commitaa68fc5256ffd5d63b8032e1adee871e90b655f1 (patch)
treeb9b869a12b41ce5a196523c4bbfcca1204ff109d /sfeed_gph.1
parente0f7dae9ac8435a254aff53f98ca66a3ee93e658 (diff)
sfeed_gph: many improvements
Diffstat (limited to 'sfeed_gph.1')
-rw-r--r--sfeed_gph.141
1 files changed, 41 insertions, 0 deletions
diff --git a/sfeed_gph.1 b/sfeed_gph.1
new file mode 100644
index 0000000..4162683
--- /dev/null
+++ b/sfeed_gph.1
@@ -0,0 +1,41 @@
+.Dd February 14, 2018
+.Dt SFEED_GPH 1
+.Os
+.Sh NAME
+.Nm sfeed_gph
+.Nd format feed data to geomyidae .gph files
+.Sh SYNOPSIS
+.Nm
+.Op Ar file...
+.Sh DESCRIPTION
+.Nm
+formats feed data (TSV) from
+.Xr sfeed 1
+from stdin or
+.Ar file
+to stdout in the geomyidae .gph file format.
+.Pp
+If one or more
+.Ar file
+are specified, the basename of the
+.Ar file
+is used as the feed name in the output.
+.Nm
+creates a index.gph index file and for each feed creates a file in the
+format feedname.gph.
+.Pp
+If no
+.Ar file
+parameters are specified and the data is read from stdin then the gph data
+is written to stdout and no files are written.
+.Bl -tag -width Ds
+.It Ev SFEED_GPH_PATH
+This environment variable can be used as the prefix for each path in the
+index.gph file.
+The default is "/".
+.El
+.Sh SEE ALSO
+.Xr geomyidae 1 ,
+.Xr sfeed 1
+.Sh AUTHORS
+.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org