Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rewrite manpages in mdoc(7) #91

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 55 additions & 75 deletions man/sndfile-generate-chirp.1
Original file line number Diff line number Diff line change
@@ -1,78 +1,58 @@
.TH SNDFILE\-GENERATE\-CHIRP 1 "May 2021" "" "User Commands"
.SH NAME
.B sndfile\-generate\-chirp
\(em create a sound file containing a swept sine wave
.SH SYNOPSIS
.B sndfile\-generate-chirp
.RB [ OPTIONS ]
.RI < sample\ rate >
.RI < length\ in\ seconds >
.RI < sound\ file >
.SH DESCRIPTION
.B sndfile\-generate\-chirp
generates a sound file containing a sine wave that
sweeps from a low starting frequency to a higher ending frequency (i.e., a
chirp).
The file is written using
.UR http://www.mega\-nerd.com/libsndfile/
libsndfile
.UE .
.P
The output file will contain floating point samples in the range
.BR [\-1.0,\ 1.0] .
The output file type is determined by the file name extension which should be
one of
.BR wav ,
.BR aifc ,
.BR aif ,
.BR aiff ,
.BR au ,
.BR caf
.Dd May 22, 2024
.Dt SNDFILE-GENERATE-CHIRP 1
.Os
.Sh NAME
.Nm sndfile-generate-chirp
.Nd create a sound file containing a swept sine wave
.Sh SYNOPSIS
.Nm
.Op Fl h
.Op Fl from Ar start
.Op Fl to Ar end
.Op Fl amp Ar value
.Op Fl log
.Op Fl quad
.Op Fl linear
.Ar rate
.Ar length
.Ar file
.Sh DESCRIPTION
.Nm
generates a sound file containing a sine wave
that sweeps from a low starting frequency to a higher ending frequency.
The file is written using libsndfile.
.Pp
The output file will contain floating point samples between -1 and 1.
The output file type is determined by the file name extension
which should be one of
.Sq wav ,
.Sq aifc ,
.Sq aif ,
.Sq aiff ,
.Sq au ,
.Sq caf
or
.BR w64 .
.SH OPTIONS
.TP
.B \-from\fR\ \fIstart
.Sq w64 .
.Pp
The options are as follows.
.Pp
.Bl -tag -compact -width fromxstartx
.It Fl h
Print a help message and exit.
.It Fl from Ar start
Sweep start frequency in Hz (default 200Hz).
.TP
.B \-to\fR\ \fIend
Sweep end frequency in Hz (default fs/2).
.TP
.B \-amp\fR\ \fIvalue
.It Fl to Ar end
Sweep end frequency in Hz (default rate/2).
.It Fl amp Ar value
Amplitude of generated sine (default 1.0).
.TP
.I sweep\ type
One of (default
.BR \-log ):
.RS +14n
.TP
.B \-log
logarithmic sweep
.TP
.B \-quad
quadratic sweep
.TP
.B \-linear
linear sweep
.RE
.TP
.BR \-h ,\ \-\-help
Print a help message and exit.
.P
The
.I length\ in\ seconds
parameter can be a decimal like
.BR 0.5 .
.SH AUTHORS
This manual page was written by
.MT erikd@mega-nerd.com
Erik de Castro Lopo
.ME
in 2009.
It has since been modified and updated by other authors.
.SH "SEE ALSO"
.BR sndfile\-jackplay (1),
.BR sndfile\-mix\-to\-mono (1),
.BR sndfile\-resample (1),
.BR sndfile\-spectrogram (1),
.BR sndfile\-waveform (1)
.It Fl log
Use a logarithmic sweep (the default).
.It Fl quad
Use a quadratic sweep.
.It Fl linear
Use a linear sweep.
.El
.Sh SEE ALSO
.Lk https://github.com/libsndfile/
.Sh AUTHORS
.An Erik de Castro Lopo Aq Mt erikd@mega-nerd.com
80 changes: 34 additions & 46 deletions man/sndfile-jackplay.1
Original file line number Diff line number Diff line change
@@ -1,50 +1,38 @@
.TH SNDFILE\-JACKPLAY 1 "May 2021" "" "User Commands"
.SH NAME
.B sndfile\-jackplay
\(em play a sound file via the JACK sound server
.SH SYNOPSIS
.B sndfile\-jackplay
.RB [ OPTIONS ]
.RI < input\ sound\ file >
.SH DESCRIPTION
.B sndfile\-jackplay
.Dd May 22, 2024
.Dt SNDFILE-JACKPLAY 1
.Os
.Sh NAME
.Nm sndfile-jackplay
.Nd play a sound file via the JACK sound server
.Sh SYNOPSIS
.Nm
.Op Fl a Op Ar port
.Op Fl h
.Op Fl l Op Ar count
.Op Fl w Op Ar port
.Ar file
.Sh DESCRIPTION
.Nm
plays the specified sound file via the JACK sound server.
It uses
.UR http://www.mega\-nerd.com/libsndfile/
libsndfile
.UE
to read the file.
.SH OPTIONS
.TP
.BR \-w ,\ \-\-wait [ =\fIport ]
Wait for input before starting playback; optionally auto-connect to
.I port
using Jack.
.TP
.BR \-a ,\ \-\-autoconnect [ =\fIport ]
It uses libsndfile to read the file.
.Pp
The options are as follows:
.Pp
.Bl -tag -compact -width wportxxxxx
.It Fl a Op Ar port
Auto-connect to
.I port
.Ar port
using Jack.
.TP
.BR \-l ,\ \-\-loop [ =\fIcount ]
Loop the file
.I count
times
.RB ( 0
for infinite).
.TP
.BR \-h ,\ \-\-help
.It Fl h
Print a help message and exit.
.SH AUTHORS
This manual page was written by
.MT erikd@mega-nerd.com
Erik de Castro Lopo
.ME
in 2009.
It has since been modified and updated by other authors.
.SH "SEE ALSO"
.BR sndfile\-generate\-chirp (1),
.BR sndfile\-mix\-to\-mono (1),
.BR sndfile\-resample (1),
.BR sndfile\-spectrogram (1),
.BR sndfile\-waveform (1)
.It Fl l Op Ar count
Loop the file
.Ar count
times, where 0 means an infinite loop.
.It Fl w Op Ar port
Wait for input before starting playback.
.El
.Sh SEE ALSO
.Lk http://libsndfile.github.io/libsndfile/
.Sh AUTHORS
.An Erik de Castro Lopo Aq Mt erikd@mega-nerd.com
55 changes: 19 additions & 36 deletions man/sndfile-mix-to-mono.1
Original file line number Diff line number Diff line change
@@ -1,37 +1,20 @@
.TH SNDFILE\-MIX\-TO\-MONO 1 "May 2021" "" "User Commands"
.SH NAME
.B sndfile\-mix\-to\-mono
\(em mix a multi-channel sound file to mono
.SH SYNOPSIS
.B sndfile\-mix\-to\-mono
.RI < multi\-channel\ input\ file >
.RI < mono\ output\ file >
.SH DESCRIPTION
.B sndfile\-mix\-to\-mono
.Dd May 22, 2024
.Dt SNDFILE-MIX-TO-MONO 1
.Os
.Sh NAME
.Nm sndfile-mix-to-mono
.Nd mix a multi-channel sound file to mono
.Sh SYNOPSIS
.Nm
.Ar ifile
.Ar ofile
.Sh DESCRIPTION
.Nm
reads a multi-channel input file and writes a single-channel output file
consisting of all of the input channels mixed together (like an audio mixing
desk would do).
The input and output files are read/written using
.UR http://www.mega\-nerd.com/libsndfile/
libsndfile
.UE .
.LP
The format of the output file is determined by the filename extension
of the output file.
.SH OPTIONS
.TP
.BR \-h ,\ \-\-help
Print a help message and exit.
.SH AUTHORS
This manual page was originally written by
.MT erikd@mega-nerd.com
Erik de Castro Lopo
.ME
in 2009.
It has since been modified and updated by other authors.
.SH "SEE ALSO"
.BR sndfile\-generate\-chirp (1),
.BR sndfile\-jackplay (1),
.BR sndfile\-resample (1),
.BR sndfile\-spectrogram (1),
.BR sndfile\-waveform (1)
consisting of all of the input channels mixed into one.
The files are read and written using libsndfile.
The format of the output file is determined by its filename extension.
.Sh SEE ALSO
.Lk https://github.com/libsndfile/
.Sh AUTHORS
.An Erik de Castro Lopo Aq Mt erikd@mega-nerd.com
Loading