History

plan9: provide a basic man page

Sigrid Haflínudóttir committed 6 years ago

Commit 4d42f221 parent 8d326d83 files · +62 −2Browse files

Unified · Split

3 files
  1. mkfile +4 −1
  2. orca.man +57 −0
  3. plan9.c +1 −1
mkfile+4−1
@@ -2,7 +2,8 @@ · 1 unmodified line
2 2
3TARG=orca3TARG=orca
4CFLAGS=$CFLAGS -p -D__plan9__4CFLAGS=$CFLAGS -p -D__plan9__
5BIN=/$objtype/bin/audio5BIN=/$objtype/bin/games
6MAN=/sys/man/1
6 7
7HFILES=\8HFILES=\
8 field.h\9 field.h\
@@ -21,3 +22,5 @@ OFILES=\ · 12 unmodified lines
21default:V: all22default:V: all
22 23
23</sys/src/cmd/mkone24</sys/src/cmd/mkone
25
26install:V: $MAN/$TARG
orca.man+57−0
@@ -0,0 +1,57 @@
1.TH ORCA 1
2.SH NAME
3orca \- an esoteric programming language designed to quickly create procedural sequencers
4.SH SYNOPSIS
5.B games/orca
6[
7.I -i
8] [
9.I -p
10] [
11.I -bpm bpm
12] [
13.I -s WxH
14] [
15.I -r random_seed
16] [
17.I file
18]
19.SH DESCRIPTION
20.I Orca
21is not a synthesizer, but a flexible livecoding
22environment capable of sending MIDI, OSC & UDP to your audio/visual
23interfaces.
24.PP
25Every letter of the alphabet is an operation, where lowercase letters
26operate on bang, uppercase letters operate each frame.
27.PP
28There are a number of options:
29.TP
30.B -i
31By default Orca uses "dark" theme.
32Use
33.B -i
34to invert the colors.
35.TP
36.B -s
37Sets the initial dimensions of the grid to
38.IR W
39x
40.IR H .
41.TP
42.B -p
43Starts
44.I Orca
45in a paused state.
46.TP
47.B -r
48Starts with a specific random seed.
49.TP
50.B -b
51Sets initial "beats per minute" value.
52.EE
53Extensive documentation and examples are available on the project's
54GitHub web page.
55.EE
56.SH SOURCE
57https://github.com/Hundredrabbits/Orca
plan9.c+1−1
@@ -802,7 +802,7 @@ selext(int xdt, int ydt) · 801 unmodified lines
802static void802static void
803usage(void)803usage(void)
804{804{
805 print("usage: %s [-i] [-p] [-b bpm] [-s WxH] [-r random_seed] [FILE]\n", argv0);805 print("usage: %s [-i] [-p] [-b bpm] [-s WxH] [-r random_seed] [file]\n", argv0);
806 threadexitsall("usage");806 threadexitsall("usage");
807}807}
808 808

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t