2020-03-23 04:49:41 +00:00
|
|
|
.TH "SPACEWALK" "1" "" "Version 1.0" "spacewalk"
|
|
|
|
.hy
|
|
|
|
.SH NAME
|
|
|
|
.PP
|
|
|
|
\f[B]spacewalk\f[] \- feed manager/generator for the gemini protocol
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.PP
|
|
|
|
.PD
|
|
|
|
\f[B]spacewalk\f[] \f[I]command\f[] [\f[I]args...\f[]]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.PP
|
|
|
|
spacewalk lets users generate and manage an unlimited number of feeds
|
|
|
|
got sites hosted via the gemini protocol. spacewalk can check for
|
|
|
|
updates to sites and generate an feed page in text/gemini format
|
|
|
|
sorted by date of last update for each site in the feed. Users can
|
|
|
|
have as many feeds as they like.
|
|
|
|
.SH COMMANDS
|
|
|
|
.PP
|
|
|
|
When you run \f[B]spacewalk\f[] with no arguments a help message is
|
|
|
|
displayed, listing all available commands with their options.
|
|
|
|
.SS create \f[I]flightname\f[]
|
|
|
|
.PP
|
|
|
|
Create a new flight (feed).
|
|
|
|
.PP
|
|
|
|
When running \f[B]spacewalk create\f[] \f[I]flightname\f[] you will be
|
|
|
|
asked a few quick questions that will help you configure the flight.
|
|
|
|
You will set a launch path (the filepath for the output file), a header
|
|
|
|
path, and a footer path. Headers and footers are optional items that
|
|
|
|
can be concatenated at the beginning and ending of your flight's
|
|
|
|
output file. If you do not want to use headers and footers leave
|
|
|
|
the paths blank.
|
|
|
|
.SS update \f[I]flightname item value\f[]
|
|
|
|
.PP
|
|
|
|
Update a flight's manifest.
|
|
|
|
.PP
|
|
|
|
This command allows a user to change a flight's launch path, header path,
|
|
|
|
or footer path (the item) to the given value.
|
|
|
|
.PP
|
|
|
|
The following items are valid:
|
|
|
|
.IP
|
|
|
|
.nf
|
|
|
|
\f[C]
|
|
|
|
launch
|
|
|
|
header
|
|
|
|
footer
|
|
|
|
\f[]
|
|
|
|
.SS remove \f[I]flightname\f[]
|
|
|
|
.PP
|
|
|
|
Remove the given flight from the system. Will delete the flight's
|
|
|
|
manifest and log. This is irreversible. Be careful.
|
|
|
|
.SS add \f[I]flightname url title\f[]
|
|
|
|
.PP
|
|
|
|
Add a site represented by the given title and found at the given url
|
|
|
|
to the given flight. The title will be displayed in the launch
|
|
|
|
command's output and the url will be where that title links to.
|
|
|
|
.SS delete \f[I]flightname title\f[]
|
|
|
|
.PP
|
|
|
|
Removes the site represented by the title from the given flight.
|
|
|
|
.SS show [\f[I]flightname\f[]]
|
|
|
|
.PP
|
|
|
|
When run without a flight name \f[B]show\f[] will show the manifest
|
|
|
|
for each flight. When run with a flight name \f[B]show\f[] will show
|
|
|
|
the manifest for the given flight as well as the log (list of sites)
|
|
|
|
for that flight.
|
|
|
|
.SS launch [\f[I]flightname\f[]]
|
|
|
|
.PP
|
|
|
|
When run without a flight name \f[B]launch\f[] will launch all available
|
|
|
|
flights. When run with a flight name \f[B]launch\f[] will launch only
|
|
|
|
that flight. Launching a flight consists of checking for updates to
|
|
|
|
every site in the flight's log and generating the output page. The
|
|
|
|
output page is then saved at the location specified in the flight's
|
|
|
|
manifest as the \f[I]launch path\f[].
|
|
|
|
.PP
|
|
|
|
Once a flight is set up with some sites on its flight log a user will
|
|
|
|
likely want to run the \f[B]launch\f[] command on a timed job at some
|
|
|
|
regular interval. This can be set up separately for each flight or as
|
|
|
|
a group by running launch without passing a flight name. When done on
|
|
|
|
a server, this allows for automatically updated feeds of curated
|
|
|
|
collections of sites. spacewalk's ability to manage multiple of these
|
|
|
|
allows for users to create themed indexes that catalog all of their
|
|
|
|
favorite gemini content in an organized, up to date, and automatic
|
|
|
|
way.
|
|
|
|
.SH FILES
|
|
|
|
.PP
|
|
|
|
\f[B]spacewalk\f[] recognizes the environment variable
|
|
|
|
\f[B]$XDG_DATA_HOME\f[] and will use it for storing data when available.
|
|
|
|
If it is not set then \f[I]~/.local/share/spacewalk/\f[] will be used
|
|
|
|
for storing the main flight manifest and a subfolder, \f[I]/flights/\f[]
|
|
|
|
is used for storing all of the flight logs.
|
|
|
|
.PP
|
|
|
|
While these can be edited manually, it is highly recommended to use the
|
|
|
|
program to interact with these files.
|
|
|
|
.SH BUGS
|
|
|
|
Oh, there are likely bugs. This is software after all...
|
|
|
|
.PP
|
2020-03-23 04:50:41 +00:00
|
|
|
See issues at: <https://tildegit.org/sloum/spacewalk/issues>
|
2020-03-23 04:49:41 +00:00
|
|
|
.SH AUTHOR
|
|
|
|
.PP
|
|
|
|
spacewalk is developed by sloum < sloum AT rawtext.club >
|