xref: /freebsd/usr.bin/mididump/mididump.1 (revision f57efe95cc25ae527c632d4ffcf064799f922216)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2024 The FreeBSD Foundation
5.\"
6.\" Portions of this software were developed by Christos Margiolis
7.\" <christos@FreeBSD.org> under sponsorship from the FreeBSD Foundation.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd September 14, 2024
31.Dt MIDIDUMP 1
32.Os
33.Sh NAME
34.Nm mididump
35.Nd dump MIDI events
36.Sh SYNOPSIS
37.Nm
38.Op Fl t
39.Ar device
40.Sh DESCRIPTION
41The
42.Nm
43utility is used to dump MIDI 1.0 events in real-time.
44.Pp
45The options are as follows:
46.Bl -tag -width "-t"
47.It Fl t
48Print "Timing Clock" events.
49These events are not printed by default, as they tend to clutter output.
50.El
51.Pp
52The
53.Ar device
54argument corresponds to the MIDI device (e.g.
55.Pa /dev/umidi0.0 ) .
56.Sh SEE ALSO
57.Rs
58.%T Summary of MIDI 1.0 Messages
59.%U https://midi.org/summary-of-midi-1-0-messages
60.Re
61.Rs
62.%T Expanded MIDI 1.0 Messages List (Status Bytes)
63.%U https://midi.org/expanded-midi-1-0-messages-list
64.Re
65.Rs
66.%T Standard MIDI-File Format Spec. 1.1, updated
67.%U https://www.music.mcgill.ca/~ich/classes/mumt306/StandardMIDIfileformat.html
68.Re
69.Rs
70.%T MIDI CC List for Continuous Controllers
71.%U https://anotherproducer.com/online-tools-for-musicians/midi-cc-list/
72.Re
73.Sh AUTHORS
74The
75.Nm
76utility was implemented by
77.An Christos Margiolis Aq Mt christos@FreeBSD.org
78under sponsorship from the
79.Fx
80Foundation.
81