third_party_libsnd/man/sndfile-metadata-get.1
Erik de Castro Lopo 576d9edf8f Manpage updates/improvementss.
* Explicitly name options instead of just [options].
* Replace needless verbiage by standard macros.
* Order options alphabetically.
* Add a few cross-references.
* Minor punctuation nits.

Patch-from: Jan Stary <hans@stare.cz>
2014-11-03 19:39:30 -08:00

117 lines
2.4 KiB
Groff

.Dd November 2, 2014
.Dt SNDFILE-METADATA-GET 1
.Os
.Sh NAME
.Nm sndfile-metadata-get ,
.Nm sndfile-metadata-set
.Nd get or set metadata in a sound file
.Sh SYNOPSIS
.Nm sndfile-metadata-get
.Op Ar options
.Ar file
.Nm sndfile-metadata-set
.Op Ar options
.Ar file
.Nm sndfile-metadata-set
.Op Ar options
.Ar input
.Ar output
.Sh DESCRIPTION
.Nm sndfile-metadata-get
displays bext and string metadata stored in an audio file.
The following options specify what to print.
.Pp
.Bl -tag -width bext-descriptionXXXX -compact
.It Fl -all
all metadata
.It Fl -bext-description
description
.It Fl -bext-originator
originator info
.It Fl -bext-orig-ref
originator reference
.It Fl -bext-umid
Unique Material Identifier
.It Fl -bext-orig-date
origination date
.It Fl -bext-orig-time
origination time
.It Fl -bext-coding-hist
coding history
.It Fl -str-title
title
.It Fl -str-copyright
copyright
.It Fl -str-artist
artist
.It Fl -str-comment
comment
.It Fl -str-date
creation date
.It Fl -str-album
album
.It Fl -str-license
license
.El
.Pp
.Nm sndfile-metadata-set
sets bext and string metadata in an audio file if the format supports it.
If the file does not contain a BEXT chunk to be modified,
the second synopsis must be used, where another output file
capable of storing the metadata is created.
This file is overwritten if it already exists.
The following options take an argument specifying the metadata:
.Pp
.Bl -tag -width bext-coding-histXXXXXXX -compact
.It Fl -bext-description
description
.It Fl -bext-originator
originator
.It Fl -bext-orig-ref
originator reference
.It Fl -bext-umid
Unique Material Identifier
.It Fl -bext-orig-date
origination date
.It Fl -bext-orig-time
origination time
.It Fl -bext-coding-hist
coding history
.It Fl -bext-time-raf
time reference
.It Fl -str-comment
comment
.It Fl -str-title
title
.It Fl -str-copyright
copyright
.It Fl -str-artist
artist
.It Fl -str-date
date
.It Fl -str-album
album
.It Fl -str-license
license
.El
.Pp
The following options take no argument:
.Pp
.Bl -tag -width bext-coding-histXXXXXXX -compact
.It Fl -bext-auto-time-date
Set the BEXT time and date to current.
.It Fl -bext-auto-time
Set the BEXT time to current.
.It Fl -bext-auto-date
Set the BEXT date to current.
.It Fl -str-auto-date
Set the string date to current.
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Lk http://www.mega-nerd.com/libsndfile/
.Lk http://tech.ebu.ch/docs/tech/tech3285.pdf
.Sh AUTHORS
.An Erik de Castro Lopo Aq Mt erikd@mega-nerd.com