summaryrefslogtreecommitdiff
path: root/utility/makecsd.xml
blob: 2ad99a8167e988287bbe856f916ea2563bd01ac3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<refentry id="makecsd">
  <refentryinfo><title>Utilities</title></refentryinfo>
  <refmeta>
    <refentrytitle>makecsd</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>makecsd</refname>
    <refpurpose>
      Creates a CSD file from the specified input files.
      <indexterm id="IndexMakecsd"><primary>makecsd</primary></indexterm>
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
    	Creates a CSD file from the specified input files. The first
    	input file that has a .orc extension (case is not significant)
    	is put to the &lt;CsInstruments&gt; section, and the first input
    	file that has a .sco extension becomes &lt;CsScore&gt;. Any
    	remaining files are Base64 encoded and added as &lt;CsFileB&gt;
    	tags. An empty &lt;CsOptions&gt; section is always added.
    </para>

    <para>

    Some text filtering is performed on the orchestra and score file:

    <itemizedlist>
    	<listitem>
    		<para>
    			newlines are converted to the native format of the
    			system on which makecsd is being run.
    		</para>
    	</listitem>


    	<listitem>
    		<para>
    			blank lines are removed from the beginning and end of
    			files.
    		</para>
    	</listitem>

    	<listitem>
    		<para>
    			any trailing whitespace is removed from the end of
    			lines.
    		</para>
    	</listitem>

    	<listitem>
    		<para>
    			optionally, tabs can be expanded to spaces with an user
    			specified tabstop size.
    		</para>
    	</listitem>

    </itemizedlist>

    </para>

  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>makecsd</command> [OPTIONS ... ] infile1 [ infile2 [ ... ]]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      Flags:
      <itemizedlist>
        <listitem>
        	<para>
        		- <emphasis>t n</emphasis>
        		= expand tabs to spaces using tabstop size n (default:
        		disabled). This applies only to the orchestra and score
        		file.
        	</para>
        </listitem>

        <listitem>
        	<para>
        		- <emphasis>w n</emphasis>
        		= set Base64 line width to n (default: 72). Note: the
            orchestra and score are not wrapped.
        	</para>
        </listitem>

        <listitem>
        	<para>
        		- <emphasis>o fname</emphasis>
        		= output file name (default: stdout)
        	</para>
        </listitem>
      </itemizedlist>

    </para>

  </refsect1>

  <refsect1>
  	<title>Examples</title>
  	<para>

<programlisting>
    <emphasis>makecsd</emphasis> -t 6 -w 78 -o file.csd file.mid file.orc file.sco sample.aif</programlisting>


  		This creates a CSD from file.orc and file.sco (tabs are
  		expanded to spaces assuming a tabstop size of 6 characters),
  		and file.mid and sample.aif are added as &lt;CsFileB&gt; tags
  		containing Base64 encoded data with a line width of 78
  		characters. The output file is file.csd.
  	</para>

  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: Istvan Varga</para>
    <para>Jan 2003</para>
  </refsect1>

</refentry>