ref: 4d42f22a75150a8a548df75bb1cdb6b2466422ff
parent: 8d326d8f39933da20d56c15f906cd6d5e28054bd
author: Sigrid Haflínudóttir <ftrvxmtrx@gmail.com>
date: Mon Feb 17 10:01:05 EST 2020
plan9: provide a basic man page
--- a/mkfile
+++ b/mkfile
@@ -2,7 +2,8 @@
TARG=orca
CFLAGS=$CFLAGS -p -D__plan9__
-BIN=/$objtype/bin/audio
+BIN=/$objtype/bin/games
+MAN=/sys/man/1
HFILES=\
field.h\
@@ -21,3 +22,5 @@
default:V: all
</sys/src/cmd/mkone
+
+install:V: $MAN/$TARG
--- /dev/null
+++ b/orca.man
@@ -1,0 +1,57 @@
+.TH ORCA 1
+.SH NAME
+orca \- an esoteric programming language designed to quickly create procedural sequencers
+.SH SYNOPSIS
+.B games/orca
+[
+.I -i
+] [
+.I -p
+] [
+.I -bpm bpm
+] [
+.I -s WxH
+] [
+.I -r random_seed
+] [
+.I file
+]
+.SH DESCRIPTION
+.I Orca
+is not a synthesizer, but a flexible livecoding
+environment capable of sending MIDI, OSC & UDP to your audio/visual
+interfaces.
+.PP
+Every letter of the alphabet is an operation, where lowercase letters
+operate on bang, uppercase letters operate each frame.
+.PP
+There are a number of options:
+.TP
+.B -i
+By default Orca uses "dark" theme.
+Use
+.B -i
+to invert the colors.
+.TP
+.B -s
+Sets the initial dimensions of the grid to
+.IR W
+x
+.IR H .
+.TP
+.B -p
+Starts
+.I Orca
+in a paused state.
+.TP
+.B -r
+Starts with a specific random seed.
+.TP
+.B -b
+Sets initial "beats per minute" value.
+.EE
+Extensive documentation and examples are available on the project's
+GitHub web page.
+.EE
+.SH SOURCE
+https://github.com/Hundredrabbits/Orca
--- a/plan9.c
+++ b/plan9.c
@@ -802,7 +802,7 @@
static void
usage(void)
{- print("usage: %s [-i] [-p] [-b bpm] [-s WxH] [-r random_seed] [FILE]\n", argv0);+ print("usage: %s [-i] [-p] [-b bpm] [-s WxH] [-r random_seed] [file]\n", argv0); threadexitsall("usage");}