OXYGENHUB
◆ main openmsx / doc / openmsx.sgml
6.7 KiB · last changed chore(): initial commit 1 month ago source blame history raw
1
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3
<!-- Process this file with docbook-to-man to generate an nroff manual
4
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
5
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6
     less'.  A typical entry in a Makefile or Makefile.am is:
7
8
manpage.1: manpage.sgml
9
	docbook-to-man $< > $@
10
11
12
	The docbook-to-man binary is found in the docbook-to-man package.
13
	Please remember that if you create the nroff version in one of the
14
	debian/rules file targets (such as build), you will need to include
15
	docbook-to-man in your Build-Depends control field.
16
17
  -->
18
19
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
20
  <!ENTITY dhfirstname "<firstname>Joost</firstname>">
21
  <!ENTITY dhsurname   "<surname>Damad</surname>">
22
  <!-- Please adjust the date whenever revising the manpage. -->
23
  <!ENTITY dhdate      "<date>October 10, 2004</date>">
24
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
25
       allowed: see man(7), man(1). -->
26
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
27
  <!ENTITY dhemail     "<email>[email protected]</email>">
28
  <!ENTITY dhusername  "Joost Yervante Damad">
29
  <!ENTITY dhucpackage "<refentrytitle>OPENMSX</refentrytitle>">
30
  <!ENTITY dhpackage   "openmsx">
31
32
  <!ENTITY debian      "<productname>Debian</productname>">
33
  <!ENTITY gnu         "<acronym>GNU</acronym>">
34
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
35
]>
36
37
<refentry>
38
  <refentryinfo>
39
    <address>
40
      &dhemail;
41
    </address>
42
    <author>
43
      &dhfirstname;
44
      &dhsurname;
45
    </author>
46
    <copyright>
47
      <year>2003</year>
48
      <holder>&dhusername;</holder>
49
    </copyright>
50
    &dhdate;
51
  </refentryinfo>
52
  <refmeta>
53
    &dhucpackage;
54
55
    &dhsection;
56
  </refmeta>
57
  <refnamediv>
58
    <refname>&dhpackage;</refname>
59
60
    <refpurpose>perfectly emulate the MSX standard and more</refpurpose>
61
  </refnamediv>
62
  <refsynopsisdiv>
63
    <cmdsynopsis>
64
      <command>&dhpackage;</command>
65
    </cmdsynopsis>
66
  </refsynopsisdiv>
67
  <refsect1>
68
    <title>DESCRIPTION</title>
69
70
    <para>This manual page documents briefly the
71
      <command>&dhpackage;</command> command.</para>
72
73
    <para>This manual page is mainly meant to point to
74
      the available documentation in the
75
      <application>HTML</application> format; see below.</para>
76
77
    <para><command>&dhpackage;</command> is the MSX emulator that aims for perfection.</para>
78
79
	<para>Supported file types of MSX media:
80
	<itemizedlist mark='opencircle'>
81
		<listitem>
82
		<para>cas: tape image in fMSX CAS format</para>
83
		</listitem>
84
		<listitem>
85
		<para>di1, di2, dsk, xsa: disk image</para>
86
		</listitem>
87
		<listitem>
88
		<para>rom: ROM image of a cartridge</para>
89
		</listitem>
90
		<listitem>
91
		<para>wav: Raw tape image, as recorded from real tape</para>
92
		</listitem>
93
		<listitem>
94
		<para>ogv: Video recording, as recorded from real Laserdisc Player</para>
95
		</listitem>
96
	</itemizedlist>
97
	  </para>
98
	  <para>
99
	  Zlib compressed files can also be used.
100
	</para>
101
102
  </refsect1>
103
  <refsect1>
104
    <title>OPTIONS</title>
105
106
    <para>The program follows the usual a command line syntax,
107
      with long options starting with two dashes (`-'). Some commands also
108
	  start with one dash.
109
	  A short summary of options is included below. </para>
110
    <variablelist>
111
      <varlistentry>
112
        <term>
113
          <option>-h</option>
114
          <option>--help</option>
115
        </term>
116
        <listitem>
117
          <para>Show summary of options; at least a completer summary than this one.</para>
118
        </listitem>
119
      </varlistentry>
120
      <varlistentry>
121
        <term>
122
		<option>-v</option>
123
		<option>--version</option>
124
        </term>
125
        <listitem>
126
          <para>Show version of program.</para>
127
        </listitem>
128
      </varlistentry>
129
      <varlistentry>
130
        <term>
131
		<option>-cart</option>
132
		<option>-carta</option>
133
		<option>-cartb</option>
134
        </term>
135
        <listitem>
136
          <para>Insert the ROM file (cartridge) specified in argument</para>
137
        </listitem>
138
      </varlistentry>
139
      <varlistentry>
140
        <term>
141
		<option>-cassetteplayer</option>
142
        </term>
143
        <listitem>
144
          <para>Put WAV or CAS tape image specified in argument in virtual cassette player</para>
145
        </listitem>
146
      </varlistentry>
147
      <varlistentry>
148
        <term>
149
			<option>-control</option>
150
        </term>
151
        <listitem>
152
          <para>Enable external control of openMSX process</para>
153
        </listitem>
154
      </varlistentry>
155
      <varlistentry>
156
        <term>
157
			<option>-diska</option>
158
			<option>-diskb</option>
159
        </term>
160
        <listitem>
161
          <para>Insert the disk image specified in argument</para>
162
        </listitem>
163
      </varlistentry>
164
      <varlistentry>
165
        <term>
166
			<option>-ext</option>
167
        </term>
168
        <listitem>
169
          <para>Insert the extension specified in argument</para>
170
        </listitem>
171
      </varlistentry>
172
      <varlistentry>
173
        <term>
174
			<option>-machine</option>
175
        </term>
176
        <listitem>
177
          <para>Use machine specified in argument</para>
178
        </listitem>
179
      </varlistentry>
180
      <varlistentry>
181
        <term>
182
		<option>-laserdisc</option>
183
        </term>
184
        <listitem>
185
          <para>Put ogv video file specified in argument in virtual Laserdisc player</para>
186
        </listitem>
187
      </varlistentry>
188
      <varlistentry>
189
        <term>
190
			<option>-setting</option>
191
        </term>
192
        <listitem>
193
          <para>Load an alternative settings file</para>
194
        </listitem>
195
      </varlistentry>
196
    </variablelist>
197
  </refsect1>
198
  <refsect1>
199
    <title>SEE ALSO</title>
200
201
    <para>openmsx-catapult (1).</para>
202
203
    <para>The program is documented fully by <citetitle>openMSX User's Manual</citetitle> and the <citetitle>openMSX Setup Guide</citetitle>, available in HTML at the location
204
      <application>/usr/share/doc/openmsx/manual</application> on most systems.</para>
205
  </refsect1>
206
  <refsect1>
207
    <title>AUTHOR</title>
208
209
    <para>This manual page was originally written by &dhusername; &dhemail; for
210
      the &debian; system, but is now maintained by the openMSX team.  Permission is
211
      granted to copy, distribute and/or modify this document under
212
      the terms of the &gnu; General Public License, Version 2 any
213
	  later version published by the Free Software Foundation.
214
    </para>
215
	<para>
216
	  On Debian systems, the complete text of the GNU General Public
217
	  License can be found in /usr/share/common-licenses/GPL.
218
	</para>
219
220
  </refsect1>
221
</refentry>
222
223
<!-- Keep this comment at the end of the file
224
Local variables:
225
mode: sgml
226
sgml-omittag:t
227
sgml-shorttag:t
228
sgml-minimize-attributes:nil
229
sgml-always-quote-attributes:t
230
sgml-indent-step:2
231
sgml-indent-data:t
232
sgml-parent-document:nil
233
sgml-default-dtd-file:nil
234
sgml-exposed-tags:nil
235
sgml-local-catalogs:nil
236
sgml-local-ecat-files:nil
237
End:
238
-->