From c3a4d586848f1a5a6e663a42ac5e841218109620 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Tue, 29 Nov 2022 15:19:38 -0500 Subject: Convert man pages to mdoc --- doc/lv2apply.1 | 101 +++++++++++++++++++++++++++++++++++++-------------------- doc/lv2bench.1 | 87 ++++++++++++++++++++++++++++++------------------- doc/lv2info.1 | 99 +++++++++++++++++++++++++++++++++++-------------------- doc/lv2ls.1 | 90 ++++++++++++++++++++++++++++++++------------------ 4 files changed, 240 insertions(+), 137 deletions(-) (limited to 'doc') diff --git a/doc/lv2apply.1 b/doc/lv2apply.1 index 8e6b037..4656ed9 100644 --- a/doc/lv2apply.1 +++ b/doc/lv2apply.1 @@ -1,37 +1,66 @@ -.\" # Copyright 2016 David Robillard +.\" # Copyright 2010-2022 David Robillard .\" # SPDX-License-Identifier: ISC - -.TH LV2APPLY 1 "05 Sep 2016" - -.SH NAME -.B lv2apply \- apply an LV2 plugin to an audio file -.SH SYNOPSIS -.B lv2apply [OPTION]... PLUGIN_URI - -.SH OPTIONS -.TP -\fB\-i IN_FILE\fR -Input file - -.TP -\fB\-o OUT_FILE\fR -Output file - -.TP -\fB\-c SYM VAL\fR -Set control port SYM to VAL - -.TP -\fB\-\-help\fR -Display help and exit - -.TP -\fB\-\-version\fR -Display version information and exit - -.SH "SEE ALSO" -.BR lv2ls(1) -.BR lv2info(1) - -.SH AUTHOR -lv2apply was written by David Robillard +.Dd Nov 29, 2022 +.Dt LV2APPLY 1 +.Os Lilv 0.24.21 +.Sh NAME +.Nm lv2apply +.Nd apply an LV2 plugin to an audio file +.Sh SYNOPSIS +.Nm lv2apply +.Op Fl Vh +.Op Fl c Ar symbol value +.Op Fl i Ar in_file +.Op Fl o Ar out_file +.Op Fl Fl help +.Op Fl Fl version +.Ar plugin_uri +.Sh DESCRIPTION +.Nm +Runs an LV2 plugin on an audio file and writes the processed output to another. +.Pp +The options are as follows: +.Pp +.Bl -tag -compact -width 3n +.It Fl V , Fl Fl version +Display version information and exit. +.Pp +.It Fl c Ar symbol value +Set control port +.Ar symbol +to +.Ar value. +.Pp +.It Fl h , Fl Fl help +Print the command line options. +.Pp +.It Fl i Ar in_file +Input file path. +.Pp +.It Fl o Ar out_file +Output file path. +.El +.Sh ENVIRONMENT +.Bl -tag -width LV2_PATH -compact +.It Ev LV2_PATH +List of directories to search for LV2 plugin bundles, +in the style of +.Ev PATH . +.El +.Sh EXIT STATUS +.Nm +exits with a status of 0, or non-zero if an error occurred. +.Sh SEE ALSO +.Bl -item -compact +.It +.Xr lv2bench 1 +.It +.Xr lv2info 1 +.It +.Xr lv2ls 1 +.El +.Sh AUTHORS +.Nm +is a part of lilv, by +.An David Robillard +.Mt d@drobilla.net . diff --git a/doc/lv2bench.1 b/doc/lv2bench.1 index 6add5d6..b1aeee5 100644 --- a/doc/lv2bench.1 +++ b/doc/lv2bench.1 @@ -1,36 +1,55 @@ .\" # Copyright 2022 David Robillard .\" # SPDX-License-Identifier: ISC - -.TH LV2BENCH 1 "08 Jul 2022" - -.SH NAME -.B lv2bench \- benchmark all installed and supported LV2 plugins -.SH SYNOPSIS -.B lv2bench [OPTIONS] [PLUGIN_URI] - -.SH OPTIONS -.TP -\fB\-b BLOCK_SIZE\fR -Block size in audio frames - -.TP -\fB\-f\fR, \fB\-\-full\fR -Full plottable output - -.TP -\fB\-h\fR, \fB\-\-help\fR -Display help and exit - -.TP -\fB\-n FRAMES\fR -Total number of audio frames to process - -.TP -\fB\-\-version\fR -Display version information and exit - -.SH "SEE ALSO" -.BR lv2ls(1) - -.SH AUTHOR -lv2bench was written by David Robillard +.Dd Nov 29, 2022 +.Dt LV2BENCH 1 +.Os Lilv 0.24.21 +.Sh NAME +.Nm lv2bench +.Nd benchmark all installed and supported LV2 plugins +.Sh SYNOPSIS +.Nm lv2bench +.Op Fl fhV +.Op Fl b Ar block_size +.Op Fl n Ar frames +.Op Fl Fl full +.Op Fl Fl help +.Op Fl Fl version +.Sh DESCRIPTION +.Nm +is a simple utility for running basic benchmarks of installed LV2 plugins. +.Pp +The options are as follows: +.Pp +.Bl -tag -compact -width 3n +.It Fl V , Fl Fl version +Display version information and exit. +.Pp +.It Fl b Ar block_size +Block size, in audio frames. +.Pp +.It Fl f , Fl Fl full +Emit full plottable output with values for every block. +.Pp +.It Fl h , Fl Fl help +Print the command line options. +.Pp +.It Fl n Ar frames +Total number of audio frames to process. +.El +.Sh EXIT STATUS +.Nm +exits with a status of 0, or non-zero if an error occurred. +.Sh SEE ALSO +.Bl -item -compact +.It +.Xr lv2apply 1 +.It +.Xr lv2info 1 +.It +.Xr lv2ls 1 +.El +.Sh AUTHORS +.Nm +is a part of lilv, by +.An David Robillard +.Mt d@drobilla.net . diff --git a/doc/lv2info.1 b/doc/lv2info.1 index 21a96c3..4712ebd 100644 --- a/doc/lv2info.1 +++ b/doc/lv2info.1 @@ -1,36 +1,65 @@ -.\" # Copyright 2009-2016 David Robillard +.\" # Copyright 2009-2022 David Robillard .\" # SPDX-License-Identifier: ISC - -.TH LV2INFO 1 "05 Sep 2016" - -.SH NAME -.B lv2info \- print information about an installed LV2 plugin -.SH SYNOPSIS -.B lv2info PLUGIN_URI - -.SH OPTIONS -.TP -\fB\-p FILE\fR -Write Turtle description of plugin to FILE - -.TP -\fB\-m FILE\fR -Add record of plugin to manifest FILE - -.TP -\fB\-\-help\fR -Display help and exit - -.TP -\fB\-\-version\fR -Display version information and exit - -.SH "SEE ALSO" -.BR lilv(3), -.BR lv2ls(1) - -.SH AUTHOR -lv2info was written by David Robillard -.PP -This manual page was written by Jaromír Mikes -and David Robillard +.Dd Nov 29, 2022 +.Dt LV2INFO 1 +.Os Lilv 0.24.21 +.Sh NAME +.Nm lv2info +.Nd print information about an installed LV2 plugin +.Sh SYNOPSIS +.Nm lv2info +.Op Fl hV +.Op Fl m Ar file +.Op Fl p Ar file +.Ar plugin_uri +.Sh DESCRIPTION +.Nm +prints a human-readable summary of information about an LV2 plugin. +.Pp +The plugin must be installed; +.Nm +will search for one with the given +.Ar plugin_uri +in the LV2 path. +.Pp +The options are as follows: +.Pp +.Bl -tag -compact -width 3n +.It Fl V , Fl Fl version +Display version information and exit. +.Pp +.It Fl h , Fl Fl help +Print the command line options. +.Pp +.It Fl m Ar file +Add record of plugin to Turtle manifest +.Ar file . +.Pp +.It Fl p Ar file +Write description of plugin to Turtle +.Ar file . +.El +.Sh ENVIRONMENT +.Bl -tag -width LV2_PATH -compact +.It Ev LV2_PATH +List of directories to search for LV2 plugin bundles, +in the style of +.Ev PATH . +.El +.Sh EXIT STATUS +.Nm +exits with a status of 0, or non-zero if an error occurred. +.Sh SEE ALSO +.Bl -item -compact +.It +.Xr lv2apply 1 +.It +.Xr lv2bench 1 +.It +.Xr lv2ls 1 +.El +.Sh AUTHORS +.Nm +is a part of lilv, by +.An David Robillard +.Mt d@drobilla.net . diff --git a/doc/lv2ls.1 b/doc/lv2ls.1 index f5457a4..fffe7c0 100644 --- a/doc/lv2ls.1 +++ b/doc/lv2ls.1 @@ -1,33 +1,59 @@ -.\" # Copyright 2010-2016 David Robillard +.\" # Copyright 2010-2022 David Robillard .\" # SPDX-License-Identifier: ISC - -.TH LV2LS 1 "26 Aug 2016" - -.SH NAME -.B lv2ls \- list all installed LV2 plugins - -.SH SYNOPSIS -.B lv2ls [OPTION]... - -.SH OPTIONS -.TP -\fB\-n\fR, \fB\-\-names\fR -Show names instead of URIs - -.TP -\fB\-\-help\fR -Display help and exit - -.TP -\fB\-\-version\fR -Display version information and exit - -.SH "SEE ALSO" -.BR lilv(3), -.BR lv2info(1) - -.SH AUTHOR -lv2ls was written by David Robillard -.PP -This manual page was written by Jaromír Mikes -and David Robillard +.Dd Nov 29, 2022 +.Dt LV2LS 1 +.Os Lilv 0.24.21 +.Sh NAME +.Nm lv2ls +.Nd list all installed LV2 plugins +.Sh SYNOPSIS +.Nm lv2ls +.Op Fl Vhn +.Op Fl Fl help +.Op Fl Fl names +.Op Fl Fl version +.Sh DESCRIPTION +.Nm +prints the URI of every installed LV2 plugin to stdout. +.Pp +Plugins are discovered with the same mechanism used by most hosts. +The default path can be overridden by setting the +.Ev LV2_PATH +environment variable. +.Pp +The options are as follows: +.Pp +.Bl -tag -compact -width 3n +.It Fl V , Fl Fl version +Display version information and exit. +.Pp +.It Fl h , Fl Fl help +Print the command line options. +.Pp +.It Fl n , Fl Fl names +Show names instead of URIs. +.El +.Sh ENVIRONMENT +.Bl -tag -width LV2_PATH -compact +.It Ev LV2_PATH +List of directories to search for LV2 plugin bundles, +in the style of +.Ev PATH . +.El +.Sh EXIT STATUS +.Nm +exits with a status of 0, or non-zero if an error occurred. +.Sh SEE ALSO +.Bl -item -compact +.It +.Xr lv2apply 1 +.It +.Xr lv2bench 1 +.It +.Xr lv2info 1 +.El +.Sh AUTHORS +.Nm +is a part of lilv, by +.An David Robillard +.Mt d@drobilla.net . -- cgit v1.2.1