diff options
Diffstat (limited to 'audio/asap/man')
-rw-r--r-- | audio/asap/man/asap-mplayer.1 | 78 | ||||
-rw-r--r-- | audio/asap/man/asap-mplayer.rst | 68 | ||||
-rw-r--r-- | audio/asap/man/asap-sdl.1 | 84 | ||||
-rw-r--r-- | audio/asap/man/asap-sdl.rst | 74 | ||||
-rw-r--r-- | audio/asap/man/asapconv.1 | 145 | ||||
-rw-r--r-- | audio/asap/man/asapconv.rst | 136 | ||||
-rw-r--r-- | audio/asap/man/sap2ntsc.1 | 77 | ||||
-rw-r--r-- | audio/asap/man/sap2ntsc.rst | 67 | ||||
-rw-r--r-- | audio/asap/man/sap2txt.1 | 134 | ||||
-rw-r--r-- | audio/asap/man/sap2txt.rst | 102 |
10 files changed, 965 insertions, 0 deletions
diff --git a/audio/asap/man/asap-mplayer.1 b/audio/asap/man/asap-mplayer.1 new file mode 100644 index 0000000000..6cf0f1681c --- /dev/null +++ b/audio/asap/man/asap-mplayer.1 @@ -0,0 +1,78 @@ +.\" 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 "ASAP-MPLAYER" 1 "2024-03-19" "5.3.0" "SlackBuilds.org" +.SH NAME +asap-mplayer \- command-line player for Atari chiptunes and mplayer +.\" RST source for asap-mplayer(1) man page. Convert with: +. +.\" rst2man.py asap-mplayer.rst > asap-sdl.1 +. +.SH SYNOPSIS +.sp +\fBasap\-mplayer\fP [\fIasapconv\-options\fP] \fBinputfile\fP +.SH DESCRIPTION +.sp +\fBasap\-mplayer\fP plays an Atari 8\-bit chiptune file, by first +converting it to \fI\&.wav\fP (with \fBasapconv\fP(1)), then running \fBmplayer\fP(1) +on the \fI\&.wav\fP file. After \fBmplayer\fP exits, the file is deleted. +.sp +The supported input formats are: SAP, CMC, CM3, CMR, CMS, DMC, DLT, +MPT, MPD, RMT, TMC, TM8, TM2 or FC. +.sp +During playback, the full set of \fBmplayer\fP keyboard controls are +available, meaning you can pause, seek forwards or backwards, speed up +or slow down playback, etc. +.sp +Note that there\(aqs no way to pass \fBmplayer\fP options on the +\fBasap\-mplayer\fP command line, but your \fB~/.mplayer/config\fP will be +read as usual. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-h\fP, \fB\-\-help\fP +Show built\-in help. +.UNINDENT +.sp +Any other options are passed to \fBasapconv\fP as\-is. The most useful +option would probably be \fB\-s song\fP to select which subsong to play. +.SH COPYRIGHT +.sp +\fBasap\-mplayer\fP and this man page are released under the WTFPL. +.SH AUTHORS +.sp +\fBasap\-mplayer\fP and this man page written for the SlackBuilds.org +project by B. Watson. +.SH SEE ALSO +.sp +\fBasapconv\fP(1), \fBasap\-sdl\fP(1), \fBchksap.pl\fP(1), \fBsap2ntsc\fP(1), \fBsap2txt\fP(1) +.sp +The ASAP website: \fI\%https://asap.sourceforge.net/\fP +.\" Generated by docutils manpage writer. +. diff --git a/audio/asap/man/asap-mplayer.rst b/audio/asap/man/asap-mplayer.rst new file mode 100644 index 0000000000..2477dce339 --- /dev/null +++ b/audio/asap/man/asap-mplayer.rst @@ -0,0 +1,68 @@ +.. RST source for asap-mplayer(1) man page. Convert with: +.. rst2man.py asap-mplayer.rst > asap-sdl.1 + +.. |version| replace:: 5.3.0 +.. |date| date:: + +============ +asap-mplayer +============ + +--------------------------------------------------- +command-line player for Atari chiptunes and mplayer +--------------------------------------------------- + +:Manual section: 1 +:Manual group: SlackBuilds.org +:Date: |date| +:Version: |version| + +SYNOPSIS +======== + +**asap-mplayer** [*asapconv-options*] **inputfile** + +DESCRIPTION +=========== + +**asap-mplayer** plays an Atari 8-bit chiptune file, by first +converting it to *.wav* (with **asapconv**\(1)), then running **mplayer**\(1) +on the *.wav* file. After **mplayer** exits, the file is deleted. + +The supported input formats are: SAP, CMC, CM3, CMR, CMS, DMC, DLT, +MPT, MPD, RMT, TMC, TM8, TM2 or FC. + +During playback, the full set of **mplayer** keyboard controls are +available, meaning you can pause, seek forwards or backwards, speed up +or slow down playback, etc. + +Note that there's no way to pass **mplayer** options on the +**asap-mplayer** command line, but your **~/.mplayer/config** will be +read as usual. + +OPTIONS +======= + +**-h**, **--help** + Show built-in help. + +Any other options are passed to **asapconv** as-is. The most useful +option would probably be **-s song** to select which subsong to play. + +COPYRIGHT +========= + +**asap-mplayer** and this man page are released under the WTFPL. + +AUTHORS +======= + +**asap-mplayer** and this man page written for the SlackBuilds.org +project by B. Watson. + +SEE ALSO +======== + +**asapconv**\(1), **asap-sdl**\(1), **chksap.pl**\(1), **sap2ntsc**\(1), **sap2txt**\(1) + +The ASAP website: https://asap.sourceforge.net/ diff --git a/audio/asap/man/asap-sdl.1 b/audio/asap/man/asap-sdl.1 new file mode 100644 index 0000000000..f9fd056121 --- /dev/null +++ b/audio/asap/man/asap-sdl.1 @@ -0,0 +1,84 @@ +.\" 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 "ASAP-SDL" 1 "2024-03-19" "6.0.3" "SlackBuilds.org" +.SH NAME +asap-sdl \- simple command-line player for Atari chiptunes +.\" RST source for asap-sdl(1) man page. Convert with: +. +.\" rst2man.py asap-sdl.rst > asap-sdl.1 +. +.SH SYNOPSIS +.sp +\fBasap\-sdl\fP [\fI\-s song\fP] \fBinputfile\fP +.SH DESCRIPTION +.sp +\fBasap\-sdl\fP plays an Atari 8\-bit chiptune file, using SDL for audio +output (in practice, this usually means PulseAudio or ALSA). +.sp +The supported input formats are: SAP, CMC, CM3, CMR, CMS, DMC, DLT, +MPT, MPD, RMT, TMC, TM8, TM2 or FC. +.sp +During playback, you can press Enter to exit. In fact, the player +doesn\(aqt exit at the end of the file (nor does it loop, unless the song +does), so you \fIhave\fP to press Enter after the song is over. +.sp +There are no other controls during playback (no way to e.g. seek +forwards or backwards). +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-h\fP, \fB\-\-help\fP +Show built\-in help. +.TP +.B \fB\-v\fP, \fB\-\-version\fP +Show version number. +.TP +.B \fB\-s\fP \fIsong\fP, \fB\-\-song\fP=song +Select subsong number (zero\-based). The default is 0, which will be +the only subsong in a file that contains only one song. Use +\fBchksap.pl \-s filename\fP to see how many subsongs exist in a file. +.UNINDENT +.SH COPYRIGHT +.sp +See the file /usr/doc/asap\-6.0.3/COPYING for license information. +.SH AUTHORS +.sp +The ASAP suite was written by Piotr Fusik, with contributions from many +others (see the website for details). +.sp +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. +.SH SEE ALSO +.sp +\fBasapconv\fP(1), \fBasap\-mplayer\fP(1), \fBchksap.pl\fP(1), \fBsap2ntsc\fP(1), \fBsap2txt\fP(1) +.sp +The ASAP website: \fI\%https://asap.sourceforge.net/\fP +.\" Generated by docutils manpage writer. +. diff --git a/audio/asap/man/asap-sdl.rst b/audio/asap/man/asap-sdl.rst new file mode 100644 index 0000000000..68ac981404 --- /dev/null +++ b/audio/asap/man/asap-sdl.rst @@ -0,0 +1,74 @@ +.. RST source for asap-sdl(1) man page. Convert with: +.. rst2man.py asap-sdl.rst > asap-sdl.1 + +.. |version| replace:: 6.0.3 +.. |date| date:: + +======== +asap-sdl +======== + +---------------------------------------------- +simple command-line player for Atari chiptunes +---------------------------------------------- + +:Manual section: 1 +:Manual group: SlackBuilds.org +:Date: |date| +:Version: |version| + +SYNOPSIS +======== + +**asap-sdl** [*-s song*] **inputfile** + +DESCRIPTION +=========== + +**asap-sdl** plays an Atari 8-bit chiptune file, using SDL for audio +output (in practice, this usually means PulseAudio or ALSA). + +The supported input formats are: SAP, CMC, CM3, CMR, CMS, DMC, DLT, +MPT, MPD, RMT, TMC, TM8, TM2 or FC. + +During playback, you can press Enter to exit. In fact, the player +doesn't exit at the end of the file (nor does it loop, unless the song +does), so you *have* to press Enter after the song is over. + +There are no other controls during playback (no way to e.g. seek +forwards or backwards). + +OPTIONS +======= + +**-h**, **--help** + Show built-in help. + +**-v**, **--version** + Show version number. + +**-s** *song*, **--song**\=song + Select subsong number (zero-based). The default is 0, which will be + the only subsong in a file that contains only one song. Use + **chksap.pl -s filename** to see how many subsongs exist in a file. + +COPYRIGHT +========= + +See the file /usr/doc/asap-|version|/COPYING for license information. + +AUTHORS +======= + +The ASAP suite was written by Piotr Fusik, with contributions from many +others (see the website for details). + +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. + +SEE ALSO +======== + +**asapconv**\(1), **asap-mplayer**\(1), **chksap.pl**\(1), **sap2ntsc**\(1), **sap2txt**\(1) + +The ASAP website: https://asap.sourceforge.net/ diff --git a/audio/asap/man/asapconv.1 b/audio/asap/man/asapconv.1 new file mode 100644 index 0000000000..926cbd8269 --- /dev/null +++ b/audio/asap/man/asapconv.1 @@ -0,0 +1,145 @@ +.\" 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 "ASAPCONV" 1 "2024-03-19" "5.3.0" "SlackBuilds.org" +.SH NAME +asapconv \- convert Atari 8-bit chiptunes to .wav or .xex files +.\" RST source for asapconv(1) man page. Convert with: +. +.\" rst2man.py asapconv.rst > asapconv.1 +. +.SH SYNOPSIS +.sp +\fBasapconv\fP [\fI\-options\fP] \fBinputfile\fP [\fI\&...\fP] +.SH DESCRIPTION +.sp +\fBasapconv\fP converts one or more Atari 8\-bit chiptune files to +\fI\&.wav\fP, raw audio sample files, \fI\&.xex\fP (Atari 8\-bit executables), or +the \fI\&.sap\fP chiptune format. +.sp +The supported input formats are: SAP, CMC, CM3, CMR, CMS, DMC, DLT, +MPT, MPD, RMT, TMC, TM8, TM2 or FC. +.sp +Although the \fB\-\-help\fP output implies that it\(aqs possible to convert +to any supported input format, non\-SAP input files can only be +converted to \fI\&.sap\fP or the same format they\(aqre already in. Attempts +to convert between two different non\-SAP formats result in "conversion +error" and a 0\-byte output file (and a non\-zero exit status). +.sp +The only useful reason to "convert" a non\-SAP file to the format it\(aqs +already in is to relocate the music to a different Atari address, +using the \fB\-\-address=\fP option. If you don\(aqt know why you\(aqd want to +do that, you don\(aqt need to do it... +.sp +The raw audio files created by \fBasapconv\fP are headerless, containing +only the audio samples. They can be played or converted with +e.g. \fBsox\fP(1). For most purposes, \fI\&.wav\fP is more convenient. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-h\fP, \fB\-\-help\fP +Show built\-in help. +.TP +.B \fB\-v\fP, \fB\-\-version\fP +Show version number. +.TP +.B \fB\-o\fP \fIfile.ext\fP, \fB\-\-output\fP=file.ext +Write output to the given file. The extension must be \fI\&.wav\fP, +\fI\&.raw\fP, \fI\&.xex\fP, \fI\&.sap\fP, or the same extension as the input file. If +only an extension is given, the filename will be derived from the +input filename. If the filename part is given as \fI\-\fP (e.g. \fI\-.wav\fP), +output is written to standard output. If \fIfile\fP includes a directory +(e.g. \fIdir/foo.wav\fP), output is written to that directory, but +\fBasapconv\fP will not create the directory (it must already +exist). Output filenames can also contain printf\-style \fB%\fP +escapes; see the \fB\-\-help\fP output for details. +.TP +.B \fB\-a\fP \fIauthor\fP, \fB\-\-author\fP=author +Sets the author name in the output file. +.TP +.B \fB\-n\fP \fIname\fP, \fB\-\-name\fP=name +Sets the music name (title) in the output file. +.TP +.B \fB\-d\fP \fIdate\fP, \fB\-\-date\fP=date +Sets the creation date (DD/MM/YYYY) in the output file. +.TP +.B \fB\-s\fP \fIsong\fP, \fB\-\-song\fP=song +Select subsong number (zero\-based). The default is 0, which will be +the only subsong in a file that contains only one song. Use +\fBchksap.pl \-s filename\fP to see how many subsongs exist in a SAP file. +.TP +.B \fB\-t\fP \fBtime\fP, \fB\-\-time\fP=time +Set output length; \fBtime\fP must be given in minutes:seconds (e.g. 1:00). +.TP +.B \fB\-\-tag\fP +Include author/title/date tags in the output. Only works for \fB\&.wav\fP +and \fB\&.xex\fP output. For \fIxex\fP files, the tag information will be shown +on the Atari screen while the song is playing. +.TP +.B \fB\-m\fP \fIchannels\fP, \fB\-\-mute\fP \fIchannels\fP +For \fI\&.wav\fP or \fI\&.raw\fP output only: Mute the given list of POKEY +channels. This is a comma\-separated list of channels numbered +1 through 8. Channels 1 to 4 are the first POKEY (only POKEY, +in an unmodified Atari), and 5 to 8 are the second POKEY in a +stereo\-modded Atari. +.TP +.B \fB\-b\fP, \fB\-\-byte\-samples\fP +Use 8\-bit samples for \fI\&.wav\fP or \fI\&.raw\fP output. +.TP +.B \fB\-w\fP, \fB\-\-word\-samples\fP +Use 16\-bit samples for \fI\&.wav\fP or \fI\&.raw\fP output. This is the default already. +.TP +.B \fB\-\-address=\fP=hex\-address +Relocate music to this address. Only useful when converting to \fI\&.sap\fP +or to the same format as the input file. +.UNINDENT +.SH EXIT STATUS +.sp +\fBasapconv\fP exits with zero status on success or non\-zero on failure. +.\" EXAMPLES +. +.\" ======== +. +.SH COPYRIGHT +.sp +See the file /usr/doc/asap\-5.3.0/COPYING for license information. +.SH AUTHORS +.sp +The ASAP suite was written by Piotr Fusik, with contributions from many +others (see the website for details). +.sp +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. +.SH SEE ALSO +.sp +\fBchksap.pl\fP(1), \fBasap\-sdl\fP(1), \fBasap\-mplayer\fP(1), \fBsap2ntsc\fP(1), \fBsap2txt\fP(1) +.sp +The ASAP website: \fI\%https://asap.sourceforge.net/\fP +.\" Generated by docutils manpage writer. +. diff --git a/audio/asap/man/asapconv.rst b/audio/asap/man/asapconv.rst new file mode 100644 index 0000000000..84057b24ac --- /dev/null +++ b/audio/asap/man/asapconv.rst @@ -0,0 +1,136 @@ +.. RST source for asapconv(1) man page. Convert with: +.. rst2man.py asapconv.rst > asapconv.1 + +.. |version| replace:: 5.3.0 +.. |date| date:: + +======== +asapconv +======== + +--------------------------------------------------- +convert Atari 8-bit chiptunes to .wav or .xex files +--------------------------------------------------- + +:Manual section: 1 +:Manual group: SlackBuilds.org +:Date: |date| +:Version: |version| + +SYNOPSIS +======== + +**asapconv** [*-options*] **inputfile** [*...*] + +DESCRIPTION +=========== + +**asapconv** converts one or more Atari 8-bit chiptune files to +*.wav*, raw audio sample files, *.xex* (Atari 8-bit executables), or +the *.sap* chiptune format. + +The supported input formats are: SAP, CMC, CM3, CMR, CMS, DMC, DLT, +MPT, MPD, RMT, TMC, TM8, TM2 or FC. + +Although the **--help** output implies that it's possible to convert +to any supported input format, non-SAP input files can only be +converted to *.sap* or the same format they're already in. Attempts +to convert between two different non-SAP formats result in "conversion +error" and a 0-byte output file (and a non-zero exit status). + +The only useful reason to "convert" a non-SAP file to the format it's +already in is to relocate the music to a different Atari address, +using the **--address=** option. If you don't know why you'd want to +do that, you don't need to do it... + +The raw audio files created by **asapconv** are headerless, containing +only the audio samples. They can be played or converted with +e.g. **sox**\(1). For most purposes, *.wav* is more convenient. + +OPTIONS +======= + +**-h**, **--help** + Show built-in help. + +**-v**, **--version** + Show version number. + +**-o** *file.ext*, **--output**\=file.ext + Write output to the given file. The extension must be *.wav*, + *.raw*, *.xex*, *.sap*, or the same extension as the input file. If + only an extension is given, the filename will be derived from the + input filename. If the filename part is given as *-* (e.g. *-.wav*), + output is written to standard output. If *file* includes a directory + (e.g. *dir/foo.wav*), output is written to that directory, but + **asapconv** will not create the directory (it must already + exist). Output filenames can also contain printf-style **%** + escapes; see the **--help** output for details. + +**-a** *author*, **--author**\=author + Sets the author name in the output file. + +**-n** *name*, **--name**\=name + Sets the music name (title) in the output file. + +**-d** *date*, **--date**\=date + Sets the creation date (DD/MM/YYYY) in the output file. + +**-s** *song*, **--song**\=song + Select subsong number (zero-based). The default is 0, which will be + the only subsong in a file that contains only one song. Use + **chksap.pl -s filename** to see how many subsongs exist in a SAP file. + +**-t** **time**, **--time**\=time + Set output length; **time** must be given in minutes:seconds (e.g. 1:00). + +**--tag** + Include author/title/date tags in the output. Only works for **.wav** + and **.xex** output. For *xex* files, the tag information will be shown + on the Atari screen while the song is playing. + +**-m** *channels*, **--mute** *channels* + For *.wav* or *.raw* output only: Mute the given list of POKEY + channels. This is a comma-separated list of channels numbered + 1 through 8. Channels 1 to 4 are the first POKEY (only POKEY, + in an unmodified Atari), and 5 to 8 are the second POKEY in a + stereo-modded Atari. + +**-b**, **--byte-samples** + Use 8-bit samples for *.wav* or *.raw* output. + +**-w**, **--word-samples** + Use 16-bit samples for *.wav* or *.raw* output. This is the default already. + +**--address=**\=hex-address + Relocate music to this address. Only useful when converting to *.sap* + or to the same format as the input file. + +EXIT STATUS +=========== + +**asapconv** exits with zero status on success or non-zero on failure. + +.. EXAMPLES +.. ======== + +COPYRIGHT +========= + +See the file /usr/doc/asap-|version|/COPYING for license information. + +AUTHORS +======= + +The ASAP suite was written by Piotr Fusik, with contributions from many +others (see the website for details). + +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. + +SEE ALSO +======== + +**chksap.pl**\(1), **asap-sdl**\(1), **asap-mplayer**\(1), **sap2ntsc**\(1), **sap2txt**\(1) + +The ASAP website: https://asap.sourceforge.net/ diff --git a/audio/asap/man/sap2ntsc.1 b/audio/asap/man/sap2ntsc.1 new file mode 100644 index 0000000000..fff17d891e --- /dev/null +++ b/audio/asap/man/sap2ntsc.1 @@ -0,0 +1,77 @@ +.\" 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 "SAP2NTSC" 1 "2024-03-19" "5.3.0" "SlackBuilds.org" +.SH NAME +sap2ntsc \- convert SAP Atari 8-bit chiptune files to NTSC timing +.\" RST source for sap2ntsc(1) man page. Convert with: +. +.\" rst2man.py sap2ntsc.rst > sap2ntsc.1 +. +.SH SYNOPSIS +.sp +\fBsap2ntsc\fP \fBinputfile\fP [\fI\&...\fP] +.SH DESCRIPTION +.sp +\fBsap2ntsc\fP converts an Atari 8\-bit chiptune in SAP format from +PAL timing to NTSC. Not all SAP files can be converted: ones that +appear to already be NTSC, or ones that use the FASTPLAY option, are +unconvertible. +.sp +\fBBeware\fP: each \fBinputfile\fP is overwritten without confirmation. +If you need backups of the original files, you should make copies +\fIbefore\fP running \fBsap2ntsc\fP\&. +.sp +Non\-SAP chiptune files (e.g. RMT, CMC) are not supported. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-h\fP, \fB\-\-help\fP +Show built\-in help. +.TP +.B \fB\-v\fP, \fB\-\-version\fP +Show version number. +.UNINDENT +.SH COPYRIGHT +.sp +See the file /usr/doc/asap\-5.3.0/COPYING for license information. +.SH AUTHORS +.sp +The ASAP suite was written by Piotr Fusik, with contributions from many +others (see the website for details). +.sp +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. +.SH SEE ALSO +.sp +\fBasapconv\fP(1), \fBasap\-sdl\fP(1), \fBasap\-mplayer\fP(1), \fBchksap.pl\fP(1), \fBsap2txt\fP(1) +.sp +The ASAP website: \fI\%https://asap.sourceforge.net/\fP +.\" Generated by docutils manpage writer. +. diff --git a/audio/asap/man/sap2ntsc.rst b/audio/asap/man/sap2ntsc.rst new file mode 100644 index 0000000000..34cc4a10d4 --- /dev/null +++ b/audio/asap/man/sap2ntsc.rst @@ -0,0 +1,67 @@ +.. RST source for sap2ntsc(1) man page. Convert with: +.. rst2man.py sap2ntsc.rst > sap2ntsc.1 + +.. |version| replace:: 5.3.0 +.. |date| date:: + +======== +sap2ntsc +======== + +----------------------------------------------------- +convert SAP Atari 8-bit chiptune files to NTSC timing +----------------------------------------------------- + +:Manual section: 1 +:Manual group: SlackBuilds.org +:Date: |date| +:Version: |version| + +SYNOPSIS +======== + +**sap2ntsc** **inputfile** [*...*] + +DESCRIPTION +=========== + +**sap2ntsc** converts an Atari 8-bit chiptune in SAP format from +PAL timing to NTSC. Not all SAP files can be converted: ones that +appear to already be NTSC, or ones that use the FASTPLAY option, are +unconvertible. + +**Beware**: each **inputfile** is overwritten without confirmation. +If you need backups of the original files, you should make copies +*before* running **sap2ntsc**. + +Non-SAP chiptune files (e.g. RMT, CMC) are not supported. + +OPTIONS +======= + +**-h**, **--help** + Show built-in help. + +**-v**, **--version** + Show version number. + +COPYRIGHT +========= + +See the file /usr/doc/asap-|version|/COPYING for license information. + +AUTHORS +======= + +The ASAP suite was written by Piotr Fusik, with contributions from many +others (see the website for details). + +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. + +SEE ALSO +======== + +**asapconv**\(1), **asap-sdl**\(1), **asap-mplayer**\(1), **chksap.pl**\(1), **sap2txt**\(1) + +The ASAP website: https://asap.sourceforge.net/ diff --git a/audio/asap/man/sap2txt.1 b/audio/asap/man/sap2txt.1 new file mode 100644 index 0000000000..a36498b24f --- /dev/null +++ b/audio/asap/man/sap2txt.1 @@ -0,0 +1,134 @@ +.\" 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 "SAP2TXT" 1 "2024-03-19" "5.3.0" "SlackBuilds.org" +.SH NAME +sap2txt \- dump or modify the header of a SAP Atari 8-bit chiptune file +.\" RST source for sap2txt(1) man page. Convert with: +. +.\" rst2man.py sap2txt.rst > sap2txt.1 +. +.SH SYNOPSIS +.sp +\fBsap2txt\fP \fBSAP\-file\fP [ > \fBtext\-file\fP ] +.sp +\fBsap2txt\fP \fBtext\-file\fP \fBSAP\-file\fP +.SH DESCRIPTION +.sp +\fBsap2txt\fP dumps the header of an Atari 8\-bit chiptune in SAP format +in human\-readable format, or replaces the header of a SAP file with +the contents of a text file previously created with \fBsap2txt\fP and +probably edited with a text editor. +.sp +With one argument, \fBsap2txt\fP reads the input SAP file and prints +its header in text format on standard output. Use redirection to +capture this in a text file (e.g. \fI>file.txt\fP). +.sp +With two arguments, \fBsap2txt\fP reads the first file as a text +file, in the format created by \fBsap2txt\fP itself, and replaces +the SAP header in the second file (which must be a valid SAP +file). \fBBeware\fP: \fBSAP\-file\fP is overwritten without confirmation. +If you need backups of the original files, you should make copies +\fIbefore\fP running \fBsap2txt\fP\&. +.sp +Non\-SAP chiptune files (e.g. RMT, CMC) are not supported. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-h\fP, \fB\-\-help\fP +Show built\-in help. +.TP +.B \fB\-v\fP, \fB\-\-version\fP +Show version number. +.UNINDENT +.SH EXAMPLE +.sp +To change the title of a SAP file, first: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +sap2txt file.sap > file.txt +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Then edit file.txt (with your preferred text editor, whatever that +is). Change the line that begins with NAME. Be careful not to remove +the double\-quotes around the name. After editing the text file, you +should make a backup of the original SAP file: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +cp file.sap file.original.sap +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Now you\(aqre ready to update the header in the SAP file: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +sap2txt file.txt file.sap +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +When you play the new file.sap, your modified title should show +up in the player. +.sp +Note that it\(aqs \fBvery bad form\fP to change the author\(aqs name to +your name and redistribute the file. In fact, you should never +redistribute modified versions of SAP files without the original +author\(aqs permission. +.SH COPYRIGHT +.sp +See the file /usr/doc/asap\-5.3.0/COPYING for license information. +.SH AUTHORS +.sp +The ASAP suite was written by Piotr Fusik, with contributions from many +others (see the website for details). +.sp +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. +.SH SEE ALSO +.sp +\fBasapconv\fP(1), \fBasap\-sdl\fP(1), \fBasap\-mplayer\fP(1), \fBchksap.pl\fP(1), \fBsap2ntsc\fP(1) +.sp +The ASAP website: \fI\%https://asap.sourceforge.net/\fP +.\" Generated by docutils manpage writer. +. diff --git a/audio/asap/man/sap2txt.rst b/audio/asap/man/sap2txt.rst new file mode 100644 index 0000000000..4b21a2723a --- /dev/null +++ b/audio/asap/man/sap2txt.rst @@ -0,0 +1,102 @@ +.. RST source for sap2txt(1) man page. Convert with: +.. rst2man.py sap2txt.rst > sap2txt.1 + +.. |version| replace:: 5.3.0 +.. |date| date:: + +======= +sap2txt +======= + +------------------------------------------------------------ +dump or modify the header of a SAP Atari 8-bit chiptune file +------------------------------------------------------------ + +:Manual section: 1 +:Manual group: SlackBuilds.org +:Date: |date| +:Version: |version| + +SYNOPSIS +======== + +**sap2txt** **SAP-file** [ > **text-file** ] + +**sap2txt** **text-file** **SAP-file** + +DESCRIPTION +=========== + +**sap2txt** dumps the header of an Atari 8-bit chiptune in SAP format +in human-readable format, or replaces the header of a SAP file with +the contents of a text file previously created with **sap2txt** and +probably edited with a text editor. + +With one argument, **sap2txt** reads the input SAP file and prints +its header in text format on standard output. Use redirection to +capture this in a text file (e.g. *>file.txt*). + +With two arguments, **sap2txt** reads the first file as a text +file, in the format created by **sap2txt** itself, and replaces +the SAP header in the second file (which must be a valid SAP +file). **Beware**: **SAP-file** is overwritten without confirmation. +If you need backups of the original files, you should make copies +*before* running **sap2txt**. + +Non-SAP chiptune files (e.g. RMT, CMC) are not supported. + +OPTIONS +======= + +**-h**, **--help** + Show built-in help. + +**-v**, **--version** + Show version number. + +EXAMPLE +======= + +To change the title of a SAP file, first:: + + sap2txt file.sap > file.txt + +Then edit file.txt (with your preferred text editor, whatever that +is). Change the line that begins with NAME. Be careful not to remove +the double-quotes around the name. After editing the text file, you +should make a backup of the original SAP file:: + + cp file.sap file.original.sap + +Now you're ready to update the header in the SAP file:: + + sap2txt file.txt file.sap + +When you play the new file.sap, your modified title should show +up in the player. + +Note that it's **very bad form** to change the author's name to +your name and redistribute the file. In fact, you should never +redistribute modified versions of SAP files without the original +author's permission. + +COPYRIGHT +========= + +See the file /usr/doc/asap-|version|/COPYING for license information. + +AUTHORS +======= + +The ASAP suite was written by Piotr Fusik, with contributions from many +others (see the website for details). + +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. + +SEE ALSO +======== + +**asapconv**\(1), **asap-sdl**\(1), **asap-mplayer**\(1), **chksap.pl**\(1), **sap2ntsc**\(1) + +The ASAP website: https://asap.sourceforge.net/ |