.\" 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.
.
|
