aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorXe <me@christine.website>2022-04-27 11:54:57 +0000
committerXe <me@christine.website>2022-04-28 01:31:49 +0000
commite9a4d1a86e05fe467006c26221b0298be41b5e34 (patch)
treefaf37533e7ba5f8c0c482cf352d79f5d5c353154 /docs
parent9a7377e8751d23ac7848e27cffdbac327306aa9e (diff)
downloadx-e9a4d1a86e05fe467006c26221b0298be41b5e34.tar.xz
x-e9a4d1a86e05fe467006c26221b0298be41b5e34.zip
add the start of a robocadey manpage
Signed-off-by: Xe <me@christine.website>
Diffstat (limited to 'docs')
-rw-r--r--docs/man1/robocadey.164
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/man1/robocadey.1 b/docs/man1/robocadey.1
new file mode 100644
index 0000000..8a30883
--- /dev/null
+++ b/docs/man1/robocadey.1
@@ -0,0 +1,64 @@
+.Dd April 27, 2022
+.Dt ROBOCADEY 1 URM
+
+
+.Sh NAME
+.Nm robocadey
+.Nd A markov chain bot for Mastodon that is fed on someone's Twitter data export
+
+
+.Sh SYNOPSIS
+.Nm
+
+.Op Fl -app-id
+.Op Fl -app-secret
+.Op Fl -instance
+.Op Fl -read-from
+.Op Fl -state
+.Op Fl -token
+
+.Sh DESCRIPTION
+
+.Bl -tag -width " " -offset indent -compact
+
+.It Fl -app-id
+oauth2 app id
+
+.It Fl -app-secret
+oauth2 app secret
+
+.It Fl -config
+configuration file, uses
+.Xr flagconfyg 4
+to format values.
+
+.It Fl -instance
+mastodon instance with https://
+
+.It Fl -read-from
+if set, read from this JSON file
+
+The default value for this is
+
+.It Fl -state
+The markov chain brain file. This is where all of the tweet data will be stored
+so that the bot can make "art" out of it.
+
+.It Fl -token
+oauth2 bot token
+
+.El
+
+.Sh DIAGNOSTICS
+
+.Ex -std robocadey
+
+
+.Sh SEE ALSO
+
+.Bl -bullet
+
+.It
+.Lk hyperlink: https://github.com/Xe/x/tree/master/mastodon/robocadey within.website/x/mastodon/robocadey
+
+.El