summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ingen.179
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/ingen.1 b/doc/ingen.1
new file mode 100644
index 00000000..66b5975e
--- /dev/null
+++ b/doc/ingen.1
@@ -0,0 +1,79 @@
+.TH INGEN 1 "08 Feb 2015"
+
+.SH NAME
+.B ingen \- A realtime modular audio processor
+
+.SH SYNOPSIS
+ingen [OPTION]...
+
+.SH OPTIONS
+
+.TP
+\fB\-C, \-\-client\-port\\fR
+Client port
+.TP
+\fB\-c, \-\-connect\fR
+Connect to engine URI
+.TP
+\fB\-e, \-\-engine\fR
+Run (JACK) engine
+.TP
+\fB\-E, \-\-engine-port\fR
+Engine listen port
+.TP
+\fB\-\-graph\-directory\fR
+Default directory for opening graphs
+.TP
+\fB\-g, \-\-gui\fR
+Launch the GTK graphical interface
+.TP
+\fB\-h, \-\-help\fR
+Print this help message
+.TP
+\fB\-\-human\-names\fR
+Show human names in GUI
+.TP
+\fB\-n, \-\-jack\-name\fR
+JACK name
+.TP
+\fB\-s, \-\-jack\-server\fR
+JACK server name
+.TP
+\fB\-l, \-\-load\fR
+Load graph
+.TP
+\fB\-L, \-\-path\fR
+Target path for loaded graph
+.TP
+\fB\-\-port\-labels\fR
+Show port labels in GUI
+.TP
+\fB\-q, \-\-queue-size\fR
+Event queue size
+.TP
+\fB\-r, \-\-run\fR
+Run script
+.TP
+\fB\-S, \-\-socket\fR
+Engine socket path
+.TP
+\fB\-u, \-\-uuid\fR
+JACK session UUID
+.TP
+\fB\-V, \-\-version\fR
+Print version information
+
+.SH AUTHOR
+Ingen was written by David Robillard <d@drobilla.net>
+
+.SH COPYRIGHT
+Copyright \(co 2005-2015 David Robillard.
+.br
+License: <https://www.gnu.org/licenses/agpl-3.0>
+.br
+This is free software; you are free to change and redistribute it.
+.br
+There is NO WARRANTY, to the extent permitted by law.
+
+.SH "SEE ALSO"
+<http://drobilla.net/software/ingen>