34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
35 |
</address> |
</address> |
36 |
</author> |
</author> |
37 |
<date month="June" year="2007"/> |
<date month="September" year="2007"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
4759 |
|
|
4760 |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
4761 |
<t>The following commands describe how to use and manage |
<t>The following commands describe how to use and manage |
4762 |
the instruments database.</t> |
the instruments database.</t> |
4763 |
|
<t>Notice:</t> |
4764 |
|
<t> |
4765 |
|
<list> |
4766 |
|
<t>All command arguments representing a path or |
4767 |
|
instrument/directory name support escape sequences as described in chapter |
4768 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>". |
4769 |
|
</t> |
4770 |
|
<t>All occurrences of a forward slash in instrument and directory |
4771 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
4772 |
|
</t> |
4773 |
|
</list> |
4774 |
|
</t> |
4775 |
|
|
4776 |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
4777 |
<t>The front-end can add a new instrument directory to the |
<t>The front-end can add a new instrument directory to the |
4949 |
<list> |
<list> |
4950 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
4951 |
<list> |
<list> |
4952 |
<t>A brief description of the directory content</t> |
<t>A brief description of the directory content. |
4953 |
|
Note that the character string may contain |
4954 |
|
<xref target="character_set">escape sequences</xref>.</t> |
4955 |
</list> |
</list> |
4956 |
</t> |
</t> |
4957 |
<t>CREATED - |
<t>CREATED - |
5115 |
</list> |
</list> |
5116 |
</t> |
</t> |
5117 |
<t>Where <dir> is the absolute path name of the directory and |
<t>Where <dir> is the absolute path name of the directory and |
5118 |
<desc> is the new description for the directory.</t> |
<desc> is the new description for the directory |
5119 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5120 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5121 |
|
|
5122 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5123 |
<t> |
<t> |
5162 |
<t>NAME='<search-string>' |
<t>NAME='<search-string>' |
5163 |
<list> |
<list> |
5164 |
<t>Restricts the search to directories, which names |
<t>Restricts the search to directories, which names |
5165 |
satisfy the supplied search string.</t> |
satisfy the supplied search string (encapsulated into apostrophes, |
5166 |
|
supporting escape sequences as described in chapter |
5167 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5168 |
</list> |
</list> |
5169 |
</t> |
</t> |
5170 |
|
|
5195 |
<t>DESCRIPTION='<search-string>' |
<t>DESCRIPTION='<search-string>' |
5196 |
<list> |
<list> |
5197 |
<t>Restricts the search to directories with description |
<t>Restricts the search to directories with description |
5198 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string |
5199 |
|
(encapsulated into apostrophes, supporting escape |
5200 |
|
sequences as described in chapter |
5201 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5202 |
</list> |
</list> |
5203 |
</t> |
</t> |
5204 |
</t> |
</t> |
5459 |
<list> |
<list> |
5460 |
<t>INSTRUMENT_FILE - |
<t>INSTRUMENT_FILE - |
5461 |
<list> |
<list> |
5462 |
<t>File name of the instrument.</t> |
<t>File name of the instrument. |
5463 |
|
Note that the character string may contain |
5464 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5465 |
</list> |
</list> |
5466 |
</t> |
</t> |
5467 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
5500 |
</t> |
</t> |
5501 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
5502 |
<list> |
<list> |
5503 |
<t>A brief description of the instrument</t> |
<t>A brief description of the instrument. |
5504 |
|
Note that the character string may contain |
5505 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5506 |
</list> |
</list> |
5507 |
</t> |
</t> |
5508 |
<t>IS_DRUM - |
<t>IS_DRUM - |
5513 |
</t> |
</t> |
5514 |
<t>PRODUCT - |
<t>PRODUCT - |
5515 |
<list> |
<list> |
5516 |
<t>The product title of the instrument</t> |
<t>The product title of the instrument. |
5517 |
|
Note that the character string may contain |
5518 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5519 |
</list> |
</list> |
5520 |
</t> |
</t> |
5521 |
<t>ARTISTS - |
<t>ARTISTS - |
5522 |
<list> |
<list> |
5523 |
<t>Lists the artist names</t> |
<t>Lists the artist names. |
5524 |
|
Note that the character string may contain |
5525 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5526 |
</list> |
</list> |
5527 |
</t> |
</t> |
5528 |
<t>KEYWORDS - |
<t>KEYWORDS - |
5529 |
<list> |
<list> |
5530 |
<t>Provides a list of keywords that refer to the instrument. |
<t>Provides a list of keywords that refer to the instrument. |
5531 |
Keywords are separated with semicolon and blank.</t> |
Keywords are separated with semicolon and blank. |
5532 |
|
Note that the character string may contain |
5533 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5534 |
</list> |
</list> |
5535 |
</t> |
</t> |
5536 |
</list> |
</list> |
5687 |
</list> |
</list> |
5688 |
</t> |
</t> |
5689 |
<t>Where <instr> is the absolute path name of the instrument and |
<t>Where <instr> is the absolute path name of the instrument and |
5690 |
<desc> is the new description for the instrument.</t> |
<desc> is the new description for the instrument |
5691 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5692 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5693 |
|
|
5694 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5695 |
<t> |
<t> |
5734 |
<t>NAME='<search-string>' |
<t>NAME='<search-string>' |
5735 |
<list> |
<list> |
5736 |
<t>Restricts the search to instruments, which names |
<t>Restricts the search to instruments, which names |
5737 |
satisfy the supplied search string.</t> |
satisfy the supplied search string (encapsulated into apostrophes, |
5738 |
|
supporting escape sequences as described in chapter |
5739 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5740 |
</list> |
</list> |
5741 |
</t> |
</t> |
5742 |
|
|
5778 |
<t>DESCRIPTION='<search-string>' |
<t>DESCRIPTION='<search-string>' |
5779 |
<list> |
<list> |
5780 |
<t>Restricts the search to instruments with description |
<t>Restricts the search to instruments with description |
5781 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5782 |
|
supporting escape sequences as described in chapter |
5783 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5784 |
</list> |
</list> |
5785 |
</t> |
</t> |
5786 |
|
|
5787 |
<t>PRODUCT='<search-string>' |
<t>PRODUCT='<search-string>' |
5788 |
<list> |
<list> |
5789 |
<t>Restricts the search to instruments with product info |
<t>Restricts the search to instruments with product info |
5790 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5791 |
|
supporting escape sequences as described in chapter |
5792 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5793 |
</list> |
</list> |
5794 |
</t> |
</t> |
5795 |
|
|
5796 |
<t>ARTISTS='<search-string>' |
<t>ARTISTS='<search-string>' |
5797 |
<list> |
<list> |
5798 |
<t>Restricts the search to instruments with artists info |
<t>Restricts the search to instruments with artists info |
5799 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5800 |
|
supporting escape sequences as described in chapter |
5801 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5802 |
</list> |
</list> |
5803 |
</t> |
</t> |
5804 |
|
|
5805 |
<t>KEYWORDS='<search-string>' |
<t>KEYWORDS='<search-string>' |
5806 |
<list> |
<list> |
5807 |
<t>Restricts the search to instruments with keyword list |
<t>Restricts the search to instruments with keyword list |
5808 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5809 |
|
supporting escape sequences as described in chapter |
5810 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5811 |
</list> |
</list> |
5812 |
</t> |
</t> |
5813 |
|
|
5920 |
</list> |
</list> |
5921 |
</t> |
</t> |
5922 |
</section> |
</section> |
5923 |
|
|
5924 |
|
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB"> |
5925 |
|
<t>The front-end can remove all instruments and directories and re-create |
5926 |
|
the instruments database structure (e.g., in case of a database corruption) |
5927 |
|
by sending the following command:</t> |
5928 |
|
<t> |
5929 |
|
<list> |
5930 |
|
<t>FORMAT INSTRUMENTS_DB</t> |
5931 |
|
</list> |
5932 |
|
</t> |
5933 |
|
|
5934 |
|
<t>Possible Answers:</t> |
5935 |
|
<t> |
5936 |
|
<list> |
5937 |
|
<t>"OK" - |
5938 |
|
<list> |
5939 |
|
<t>on success</t> |
5940 |
|
</list> |
5941 |
|
</t> |
5942 |
|
<t>"ERR:<error-code>:<error-message>" - |
5943 |
|
<list> |
5944 |
|
<t>If the formatting of the instruments database |
5945 |
|
failed.</t> |
5946 |
|
</list> |
5947 |
|
</t> |
5948 |
|
</list> |
5949 |
|
</t> |
5950 |
|
</section> |
5951 |
|
|
5952 |
</section> |
</section> |
5953 |
|
|