summaryrefslogtreecommitdiffstats
path: root/audio/sonic-visualiser/sonic-visualiser.1
diff options
context:
space:
mode:
Diffstat (limited to 'audio/sonic-visualiser/sonic-visualiser.1')
-rw-r--r--audio/sonic-visualiser/sonic-visualiser.1122
1 files changed, 89 insertions, 33 deletions
diff --git a/audio/sonic-visualiser/sonic-visualiser.1 b/audio/sonic-visualiser/sonic-visualiser.1
index f39f576533..ea0d050455 100644
--- a/audio/sonic-visualiser/sonic-visualiser.1
+++ b/audio/sonic-visualiser/sonic-visualiser.1
@@ -1,42 +1,98 @@
-.TH SONIC-VISUALISER 1 "November 17, 2010"
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "SONIC-VISUALISER" 1 "2021-12-07" "4.4" "SlackBuilds.org"
.SH NAME
-sonic-visualiser \- viewing and analysing the contents of music audio files
+sonic-visualiser \- view and analyze the contents of music files
+.\" RST source for sonic-visualiser(1) man page. Convert with:
+.
+.\" rst2man.py sonic-visualiser.rst > sonic-visualiser.1
+.
+.\" rst2man.py comes from the SBo development/docutils package.
+.
.SH SYNOPSIS
-.B sonic-visualiser
-[\fIoptions\fR] [\fIfile\fR] ...
+.sp
+sonic\-visualiser [\fI\-options\fP] [\fIfile\fP] ...
.SH DESCRIPTION
-.B Sonic Visualiser
-is a program for viewing and exploring audio data for semantic music
-analysis and annotation.
-.PP
-.B Sonic Visualiser
-could be of particular interest to musicologists, archivists,
-signal-processing researchers and anyone else looking for a friendly way to
-take a look at what lies inside the audio file.
-.PP
-After the installation, the application is available from the
-.B Applications
-menu.
+.sp
+Sonic Visualiser is an application for viewing and analysing the
+contents of music audio files. The aim of Sonic Visualiser is to be
+the first program you reach for when want to study a musical recording
+rather than simply listen to it.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-h\fR, \fB\-\-help\fR
-show this help message and exit
+.B [\fIfile\fP] ...
+One or more Sonic Visualiser session files (\fB\&.sv\fP) or audio
+files may be given as arguments.
.TP
-\fB\-\-no\-audio\fR
+.B \fB\-h\fP, \fB\-\-help\fP
+Display built\-in help.
+.TP
+.B \fB\-help\-all\fP
+Display built\-in help, including Qt\-specific options.
+.TP
+.B \fB\-v\fP, \fB\-\-version\fP
+Display Sonic Visualiser version number and exit.
+.TP
+.B \fB\-\-no\-audio\fP
Do not attempt to open an audio output device.
.TP
-\fB\-\-no\-osc\fR
+.B \fB\-no\-osc\fP
Do not provide an Open Sound Control port for remote control.
-.PP
-One or more Sonic Visualiser (.sv) and audio files may be provided.
-.SH "SEE ALSO"
-The complete documentation is available online at:
-.br
-.B
-http://www.sonicvisualiser.org/documentation.html
-.SH "AUTHOR"
-sonic-visualiser was written by Chris Cannam <cannam@users.sourceforge.net>
-and others.
-.PP
-This manual page was written by Alessio Treglia <alessio@debian.org>,
-for the Debian project (but may be used by others).
+.TP
+.B \fB\-\-no\-splash\fP
+Do not show a splash screen.
+.TP
+.B \fB\-\-osc\-script\fP \fIscriptfile\fP
+Batch run the Open Sound Control script found in the
+given file. Supply "\-" as file to read from stdin.
+Scripts consist of /command arg1 arg2 ... OSC control
+lines, optionally interleaved with numbers to specify
+pauses in seconds.
+.TP
+.B \fB\-\-first\-run\fP
+Clear any saved settings and reset to first\-run behaviour.
+.UNINDENT
+.SH COPYRIGHT
+.sp
+See the file /usr/doc/sonic\-visualiser\-4.4/COPYING for license information.
+.SH AUTHORS
+.sp
+sonic\-visualiser was initiated and developed in the Centre for Digital
+Music, Queen Mary University, of London. It is currently maintained
+primarily by Chris Cannam at Particular Programs, Ltd.
+.sp
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
+.SH SEE ALSO
+.sp
+The sonic\-visualiser homepage: \fI\%https://sonicvisualiser.org/\fP
+.\" Generated by docutils manpage writer.
+.