Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-07-31 16:09:28 +02:00
Code Issues Releases Wiki Activity

Use scdoc for man page generation

Browse Source 
Signed-off-by: Sol Fisher Romanoff <sol@solfisher.com>
This commit is contained in:
Sol Fisher Romanoff 2021-07-23 23:31:47 +03:00
parent 9ac757ebc3
commit 31fbfeec52
No known key found for this signature in database
GPG Key ID: 0E0ACA5D1C244E1F
2 changed files with 135 additions and 184 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

184
help/tenacity.1
View File

@ -1,184 +0,0 @@
.\" Process this file with
.\" groff -man -Tascii tenacity.1
.\"
.TH tenacity 1
.SH NAME
tenacity \- Graphical cross-platform audio editor
.SH SYNOPSIS
.B tenacity
\-help
.br
.B tenacity
\-version
.br
.B tenacity
[\-blocksize nnn] \-test
.br
.B tenacity
[\-blocksize nnn] [
.I AUDIO-FILE
]
.B ...
.SH DESCRIPTION
.B Tenacity
is a graphical audio editor. This man page does not
describe all of the features of Tenacity or how to use
it; for this, see the html documentation that came with
the program, which should be accessible from the Help
menu. This man page describes the Unix-specific
features, including special files and environment variables.
Tenacity currently uses
.B libsndfile
to open many uncompressed audio formats such as WAV,
AIFF, and AU, and it can also be linked to
.B libmad,
.B libvorbis,
and
.B libflac,
to provide support for opening MP2/3, Ogg Vorbis, and FLAC files,
respectively.
.B LAME, libvorbis, libflac
and
.B libtwolame
provide facilities to export files to all these formats as well.
Tenacity is primarily an interactive, graphical editor, not a batch-processing
tool. Whilst there is a basic batch processing tool it is experimental and
incomplete. If you need to batch-process audio or do simple edits
from the command line, using
.B sox
or
.B ecasound
driven by a bash script will be much more powerful than tenacity.
.SH OPTIONS
.TP 10
\fB\-help\fR
display a brief list of command line options
.TP 10
\fB\-version\fR
display the tenacity version number
.TP 10
\fB\-test\fR
run self diagnostics tests (only present in development builds)
.TP 10
\fB\-blocksize nnn\fR
set the tenacity block size for writing files to disk to nnn bytes
.SH FILES
.I ~/.audacity\-data/tenacity.cfg
.RS
Per user configuration file.
.RE
.I /var/tmp/tenacity\-<user>/
.RS
Default location of Tenacity's temp directory, where <user> is your
username. If this location is not suitable (not enough space in
/var/tmp, for example), you should change the temp directory in
the Preferences and restart Tenacity. Tenacity is a disk-based
editor, so the temp directory is very important: it should always
be on a fast (local) disk with lots of free space.
Note that older versions of Tenacity put the temp directory inside
of the user's home directory. This is undesirable on many systems,
and using some directory in /tmp is recommended.
On many modern Linux systems all files in /tmp/ will be deleted
each time the system boots up, which makes recovering a recording
that was going on when the system crashed much harder. This is why
the default is to use a directory in /var/tmp/ which will not
normally be deleted by the system. Open the Preferences to check.
.RE
.SH SEARCH PATH
When looking for plug-ins, help files, localization files, or other
configuration files, Tenacity searches the following locations, in
this order:
.I AUDACITY_PATH
.RS
Any directories in the
.I AUDACITY_PATH
environment variable will be searched before anywhere else.
.RE
.I .
.RS
The current working directory when Tenacity is started.
.RE
.I ~/.audacity-data/Plug-Ins
.I <prefix>/share/tenacity
.RS
The system-wide Tenacity directory, where <prefix> is usually
/usr or /usr/local, depending on where the program was installed.
.RE
.I <prefix>/share/doc/tenacity
.RS
The system-wide Tenacity documentation directory, where <prefix> is usually
/usr or /usr/local, depending on where the program was installed.
.RE
For localization files in particular (i.e. translations of Tenacity
into other languages), Tenacity also searches
.I <prefix>/share/locale
.SH PLUG\-INS
Tenacity supports two types of plug-ins on Unix: LADSPA and Nyquist
plug-ins. These are generally placed in a directory called
.I plug\-ins
somewhere on the search path (see above).
LADSPA plug-ins can either be in the plug-ins directory, or alternatively
in a
.I ladspa
directory on the search path if you choose to create one. Tenacity will
also search the directories in the
.I LADSPA_PATH
environment variable for additional LADSPA plug-ins.
Nyquist plug-ins can either be in the plug-ins directory, or alternatively
in a
.I nyquist
directory on the search path if you choose to create one.
.SH VERSION
This man page documents tenacity version 1.3.5
.SH LICENSE
Tenacity is distributed under the GPL, however some of the libraries
it links to are distributed under other free licenses, including the
LGPL and BSD licenses.
.SH BUGS
For details of known problems, see the release notes and the audacity wiki:
.br
http://wiki.audacityteam.org/wiki/Known_Issues
To report a bug, see the instructions at
.br
http://wiki.audacityteam.org/wiki/Reporting_Bugs
.SH AUTHORS
Tenacity would not be possible without the Audacity project,
wxWidgets, libsndfile, and many of the other libraries it is
built upon. You can find a full list of contributors on GitHub:
https://github.com/tenacityteam/tenacity/graphs/contributors
The Audacity project leaders include Dominic Mazzoni, Matt Brubeck,
James Crook, Vaughan Johnson, Leland Lucius, and Markus Meyer,
but dozens of others have contributed.
http://www.audacityteam.org/about/credits/
.\" arch-tag: 204d77ab-73cf-42b1-b5bd-e6f07e660496

135
help/tenacity.1.scd Normal file
View File

@ -0,0 +1,135 @@
tenacity(1)
# NAME
tenacity - Graphical cross-platform audio editor
# SYNOPSIS
*tenacity* -help++
*tenacity* -version
*tenacity* [-blocksize nnn] -test++
*tenacity* [-blocksize nnn] [ _AUDIO-FILE_ ] *...*
# OPTIONS
*-help*
Displays a brief list of command line options.
*-version*
Displays the Tenacity version number.
*-test*
Runs self diagnostics tests (only present in development builds).
*-blocksize nnn*
Sets the Tenacity block size for writing files to disk to nnn bytes.
# DESCRIPTION
*Tenacity* is a graphical audio editor. This man page does not describe all of
the features of Tenacity or how to use it; for this, see the html documentation
that came with the program, which should be accessible from the Help menu.
This man page describes the Unix-specific features, including special files and
environment variables.
Tenacity currently uses *libsndfile* to open many uncompressed audio formats
such as WAV, AIFF, and AU, and it can also be linked to *libmad*, *libvorbis*,
and *libflac*, to provide support for opening MP2/3, Ogg Vorbis, and FLAC
files, respectively. *LAME*, *libvorbis*, *libflac* and *libtwolame* provide
facilities to export files to all these formats as well.
Tenacity is primarily an interactive, graphical editor, not a batch-processing
tool. Whilst there is a basic batch processing tool it is experimental and
incomplete. If you need to batch-process audio or do simple edits from the
command line, using *sox* or *ecasound* driven by a bash script will be much
more powerful than tenacity.
# FILES
_~/.audacity-data/tenacity.cfg_
Per-user configuration file.
_/var/tmp/tenacity-<user>/_
Default location of Tenacity's temp directory, where <user> is your
username. If this location is not suitable (not enough space in
/var/tmp, for example), you should change the temp directory in the
Preferences and restart Tenacity. Tenacity is a disk-based editor, so
the temp directory is very important: it should always be on a fast
(local) disk with lots of free space.
Note that older versions of Tenacity put the temp directory inside of
the user's home directory. This is undesirable on many systems, and
using some directory in /tmp is recommended.
On many modern Linux systems all files in /tmp/ will be deleted each
time the system boots up, which makes recovering a recording that was
going on when the system crashed much harder. This is why the default
is to use a directory in /var/tmp/ which will not normally be deleted
by the system. Open the Preferences to check.
# SEARCH PATH
When looking for plug-ins, help files, localization files, or other
configuration files, Tenacity searches the following locations, in this order:
_AUDACITY_PATH_
Any directories in the _AUDACITY_PATH_ environment variable will be
searched before anywhere else.
_._
The current working directory when Tenacity is started.
_~/.audacity-data/Plug-Ins_
_<prefix>/share/tenacity_
The system-wide Tenacity directory, where <prefix> is usually /usr or
/usr/local, depending on where the program was installed.
_<prefix>/share/doc/tenacity_
The system-wide Tenacity documentation directory, where <prefix> is
usually /usr or /usr/local, depending on where the program was
installed.
For localization files in particular (i.e. translations of Tenacity into other
languages), Tenacity also searches _<prefix>/share/locale_.
# PLUG-INS
Tenacity supports two types of plug-ins on Unix: LADSPA and Nyquist plug-ins.
These are generally placed in a directory called _plug-ins_ somewhere on the
search path (see above).
LADSPA plug-ins can either be in the plug-ins directory, or alternatively in a
_ladspa_ directory on the search path if you choose to create one. Tenacity
will also search the directories in the _LADSPA_PATH_ environment variable for
additional LADSPA plug-ins.
Nyquist plug-ins can either be in the plug-ins directory, or alternatively in a
_nyquist_ directory on the search path if you choose to create one.
# VERSION
This man page documents Tenacity version 1.3.5.
# LICENSE
Tenacity is distributed under the GPL, however some of the libraries it links
to are distributed under other free licenses, including the LGPL and BSD
licenses.
# AUTHORS
Tenacity would not be possible without the Audacity project,
wxWidgets, libsndfile, and many of the other libraries it is
built upon. You can find a full list of contributors on GitHub:
https://github.com/tenacityteam/tenacity/graphs/contributors
The Audacity project leaders include Dominic Mazzoni, Matt Brubeck,
James Crook, Vaughan Johnson, Leland Lucius, and Markus Meyer,
but dozens of others have contributed.
http://www.audacityteam.org/about/credits/