~ubuntu-branches/ubuntu/lucid/onscripter/lucid

« back to all changes in this revision

Viewing changes to debian/onscripter.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Michael Bienia
  • Date: 2008-02-12 20:22:19 UTC
  • mfrom: (0.1.2 lenny) (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080212202219-jx4xdi0izczp0pcy
Tags: 20080121-0ubuntu1
* Fake-sync onscripter 0.0.20080121-1 from Debian unstable (LP: #187890).
  Drop the leading zeroes from the version due to different versioning in
  Debian and Ubuntu.
* debian/control:
  + Modify Maintainer value to match DebianMaintainerField spec.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>Ying-Chun</firstname>">
 
21
  <!ENTITY dhsurname   "<surname>Liu</surname>">
 
22
  <!-- Please adjust the date whenever revising the manpage. -->
 
23
  <!ENTITY dhdate      "<date>Jun 11, 2007</date>">
 
24
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
 
25
       allowed: see man(7), man(1). -->
 
26
  <!ENTITY dhsection   "<manvolnum>6</manvolnum>">
 
27
  <!ENTITY dhemail     "<email>grandpaul@gmail.com</email>">
 
28
  <!ENTITY dhusername  "Ying-Chun Liu (PaulLiu)">
 
29
  <!ENTITY dhucpackage "<refentrytitle>onscripter</refentrytitle>">
 
30
  <!ENTITY dhpackage   "onscripter">
 
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>NScripter-compatible visual novel games engine</refpurpose>
 
61
  </refnamediv>
 
62
  <refsynopsisdiv>
 
63
    <cmdsynopsis>
 
64
      <command>&dhpackage;</command>
 
65
 
 
66
      <arg rep='repeat'><option>option</option></arg>
 
67
 
 
68
    </cmdsynopsis>
 
69
  </refsynopsisdiv>
 
70
  <refsect1>
 
71
    <title>DESCRIPTION</title>
 
72
 
 
73
    <para>This manual page documents briefly the
 
74
      <command>&dhpackage;</command> command.</para>
 
75
 
 
76
    <para>This manual page was written for the &debian; distribution
 
77
      because the original program does not have a manual page.
 
78
    </para>
 
79
 
 
80
    <para><command>&dhpackage;</command> is a program that implements
 
81
    the visual novel games engine NScripter. It is able to run Japanese
 
82
    (Shift-JIS encoding) games.
 
83
    <command>&dhpackage;-1byte</command> is built in order to play 
 
84
    English games by forcing 1-byte mode.
 
85
    </para>
 
86
 
 
87
  </refsect1>
 
88
  <refsect1>
 
89
    <title>OPTIONS</title>
 
90
 
 
91
    <para>These programs follow the usual &gnu; command line syntax,
 
92
      with long options starting with two dashes (`-').  A summary of
 
93
      options is included below.  
 
94
    </para>
 
95
 
 
96
    <variablelist>
 
97
      <varlistentry>
 
98
        <term>
 
99
          <option>--cdaudio</option>
 
100
        </term>
 
101
        <listitem>
 
102
          <para>Use CD audio if available.</para>
 
103
        </listitem>
 
104
      </varlistentry>
 
105
      <varlistentry>
 
106
        <term>
 
107
          <option>--cdnumber <replaceable>no</replaceable></option>
 
108
        </term>
 
109
        <listitem>
 
110
          <para>Choose the CD-ROM drive number.</para>
 
111
        </listitem>
 
112
      </varlistentry>
 
113
      <varlistentry>
 
114
        <term><option>-f <replaceable>file</replaceable></option>
 
115
          <option>--font <replaceable>file</replaceable></option>
 
116
        </term>
 
117
        <listitem>
 
118
          <para>Set a TTF font file.</para>
 
119
        </listitem>
 
120
      </varlistentry>
 
121
      <varlistentry>
 
122
        <term>
 
123
          <option>--registry <replaceable>file</replaceable></option>
 
124
        </term>
 
125
        <listitem>
 
126
          <para>Set a registry file.</para>
 
127
        </listitem>
 
128
      </varlistentry>
 
129
      <varlistentry>
 
130
        <term>
 
131
          <option>--dll <replaceable>file</replaceable></option>
 
132
        </term>
 
133
        <listitem>
 
134
          <para>Set a dll file.</para>
 
135
        </listitem>
 
136
      </varlistentry>
 
137
      <varlistentry>
 
138
        <term><option>-r <replaceable>path</replaceable></option>
 
139
          <option>--root <replaceable>path</replaceable></option>
 
140
        </term>
 
141
        <listitem>
 
142
          <para>Set the root path to the archives.</para>
 
143
        </listitem>
 
144
      </varlistentry>
 
145
      <varlistentry>
 
146
        <term>
 
147
          <option>--fullscreen</option>
 
148
        </term>
 
149
        <listitem>
 
150
          <para>Start in fullscreen mode.</para>
 
151
        </listitem>
 
152
      </varlistentry>
 
153
      <varlistentry>
 
154
        <term>
 
155
          <option>--window</option>
 
156
        </term>
 
157
        <listitem>
 
158
          <para>Start in window mode.</para>
 
159
        </listitem>
 
160
      </varlistentry>
 
161
      <varlistentry>
 
162
        <term>
 
163
          <option>--force-button-shortcut</option>
 
164
        </term>
 
165
        <listitem>
 
166
          <para>Ignore useescspc and getenter command.</para>
 
167
        </listitem>
 
168
      </varlistentry>
 
169
      <varlistentry>
 
170
        <term>
 
171
          <option>--enable-wheeldown-advance</option>
 
172
        </term>
 
173
        <listitem>
 
174
          <para>Advance the text on mouse wheeldown event.</para>
 
175
        </listitem>
 
176
      </varlistentry>
 
177
      <varlistentry>
 
178
        <term>
 
179
          <option>--disable-rescale</option>
 
180
        </term>
 
181
        <listitem>
 
182
          <para>Do not rescale the images in the archives when compiled with -DPDA.</para>
 
183
        </listitem>
 
184
      </varlistentry>
 
185
      <varlistentry>
 
186
        <term>
 
187
          <option>--edit</option>
 
188
        </term>
 
189
        <listitem>
 
190
          <para>Enable editing the volumes and the variables when 'z' is pressed.</para>
 
191
        </listitem>
 
192
      </varlistentry>
 
193
      <varlistentry>
 
194
        <term>
 
195
          <option>--key-exe <replaceable>file</replaceable></option>
 
196
        </term>
 
197
        <listitem>
 
198
          <para>Set a file (*.EXE) that includes a key table.</para>
 
199
        </listitem>
 
200
      </varlistentry>
 
201
 
 
202
      <varlistentry>
 
203
        <term><option>-h</option>
 
204
          <option>--help</option>
 
205
        </term>
 
206
        <listitem>
 
207
          <para>Show summary of options.</para>
 
208
        </listitem>
 
209
      </varlistentry>
 
210
      <varlistentry>
 
211
        <term><option>-v</option>
 
212
          <option>--version</option>
 
213
        </term>
 
214
        <listitem>
 
215
          <para>Show version of program.</para>
 
216
        </listitem>
 
217
      </varlistentry>
 
218
    </variablelist>
 
219
  </refsect1>
 
220
  <refsect1>
 
221
    <title>EXAMPLE</title>
 
222
 
 
223
    <para>After decompressing the game data directory, we call it /path/foo for convient, please use the follow command to perform the game:</para>
 
224
<para><command>onscripter -r /path/foo</command></para>
 
225
 
 
226
    <para> If the game is not containing default.ttf, we can use -f to assign one as following:
 
227
    </para>
 
228
<para><command>onscripter -r /path/foo -f /usr/share/fonts/truetype/vlgothic/VL-Gothic-Regular.ttf</command></para>
 
229
 
 
230
  </refsect1>
 
231
  <refsect1>
 
232
    <title>AUTHOR</title>
 
233
 
 
234
    <para>This manual page was written by &dhusername; &dhemail; for
 
235
      the &debian; system (but may be used by others).  Permission is
 
236
      granted to copy, distribute and/or modify this document under
 
237
      the terms of the &gnu; General Public License, Version 2 any 
 
238
          later version published by the Free Software Foundation.
 
239
    </para>
 
240
        <para>
 
241
          On Debian systems, the complete text of the GNU General Public
 
242
          License can be found in /usr/share/common-licenses/GPL.
 
243
        </para>
 
244
 
 
245
  </refsect1>
 
246
</refentry>
 
247
 
 
248
<!-- Keep this comment at the end of the file
 
249
Local variables:
 
250
mode: sgml
 
251
sgml-omittag:t
 
252
sgml-shorttag:t
 
253
sgml-minimize-attributes:nil
 
254
sgml-always-quote-attributes:t
 
255
sgml-indent-step:2
 
256
sgml-indent-data:t
 
257
sgml-parent-document:nil
 
258
sgml-default-dtd-file:nil
 
259
sgml-exposed-tags:nil
 
260
sgml-local-catalogs:nil
 
261
sgml-local-ecat-files:nil
 
262
End:
 
263
-->