Imported Upstream version 1.0.31
[platform/upstream/libsndfile.git] / man / sndfile-metadata-get.1
1 .Dd November 2, 2014
2 .Dt SNDFILE-METADATA-GET 1
3 .Os
4 .Sh NAME
5 .Nm sndfile-metadata-get ,
6 .Nm sndfile-metadata-set
7 .Nd get or set metadata in a sound file
8 .Sh SYNOPSIS
9 .Nm sndfile-metadata-get
10 .Op Ar options
11 .Ar file
12 .Nm sndfile-metadata-set
13 .Op Ar options
14 .Ar file
15 .Nm sndfile-metadata-set
16 .Op Ar options
17 .Ar input
18 .Ar output
19 .Sh DESCRIPTION
20 .Nm sndfile-metadata-get
21 displays bext and string metadata stored in an audio file.
22 The following options specify what to print.
23 .Pp
24 .Bl -tag -width bext-descriptionXXXX -compact
25 .It Fl -all
26 all metadata
27 .It Fl -bext-description
28 description
29 .It Fl -bext-originator
30 originator info
31 .It Fl -bext-orig-ref
32 originator reference
33 .It Fl -bext-umid
34 Unique Material Identifier
35 .It Fl -bext-orig-date
36 origination date
37 .It Fl -bext-orig-time
38 origination time
39 .It Fl -bext-coding-hist
40 coding history
41 .It Fl -str-title
42 title
43 .It Fl -str-copyright
44 copyright
45 .It Fl -str-artist
46 artist
47 .It Fl -str-comment
48 comment
49 .It Fl -str-date
50 creation date
51 .It Fl -str-album
52 album
53 .It Fl -str-license
54 license
55 .El
56 .Pp
57 .Nm sndfile-metadata-set
58 sets bext and string metadata in an audio file if the format supports it.
59 If the file does not contain a BEXT chunk to be modified,
60 the second synopsis must be used, where another output file
61 capable of storing the metadata is created.
62 This file is overwritten if it already exists.
63 The following options take an argument specifying the metadata:
64 .Pp
65 .Bl -tag -width bext-coding-histXXXXXXX -compact
66 .It Fl -bext-description
67 description
68 .It Fl -bext-originator
69 originator
70 .It Fl -bext-orig-ref
71 originator reference
72 .It Fl -bext-umid
73 Unique Material Identifier
74 .It Fl -bext-orig-date
75 origination date
76 .It Fl -bext-orig-time
77 origination time
78 .It Fl -bext-coding-hist
79 coding history
80 .It Fl -bext-time-raf
81 time reference
82 .It Fl -str-comment
83 comment
84 .It Fl -str-title
85 title
86 .It Fl -str-copyright
87 copyright
88 .It Fl -str-artist
89 artist
90 .It Fl -str-date
91 date
92 .It Fl -str-album
93 album
94 .It Fl -str-license
95 license
96 .El
97 .Pp
98 The following options take no argument:
99 .Pp
100 .Bl -tag -width bext-coding-histXXXXXXX -compact
101 .It Fl -bext-auto-time-date
102 Set the BEXT time and date to current.
103 .It Fl -bext-auto-time
104 Set the BEXT time to current.
105 .It Fl -bext-auto-date
106 Set the BEXT date to current.
107 .It Fl -str-auto-date
108 Set the string date to current.
109 .El
110 .Sh EXIT STATUS
111 .Ex -std
112 .Sh SEE ALSO
113 .Lk http://libsndfile.github.io/libsndfile/
114 .Lk http://tech.ebu.ch/docs/tech/tech3285.pdf
115 .Sh AUTHORS
116 .An Erik de Castro Lopo Aq Mt erikd@mega-nerd.com