File: onscripter.sgml

package info (click to toggle)
onscripter 20200722-1
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 1,372 kB
  • sloc: cpp: 32,180; makefile: 87; sh: 60; python: 10
file content (263 lines) | stat: -rw-r--r-- 7,840 bytes parent folder | download | duplicates (7)
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@


	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Ying-Chun</firstname>">
  <!ENTITY dhsurname   "<surname>Liu</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>Jun 11, 2007</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>6</manvolnum>">
  <!ENTITY dhemail     "<email>grandpaul@gmail.com</email>">
  <!ENTITY dhusername  "Ying-Chun Liu (PaulLiu)">
  <!ENTITY dhucpackage "<refentrytitle>onscripter</refentrytitle>">
  <!ENTITY dhpackage   "onscripter">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>NScripter-compatible visual novel games engine</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg rep='repeat'><option>option</option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.
    </para>

    <para><command>&dhpackage;</command> is a program that implements
    the visual novel games engine NScripter. It is able to run Japanese
    (Shift-JIS encoding) games.
    <command>&dhpackage;-1byte</command> is built in order to play 
    English games by forcing 1-byte mode.
    </para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.  
    </para>

    <variablelist>
      <varlistentry>
        <term>
          <option>--cdaudio</option>
        </term>
        <listitem>
          <para>Use CD audio if available.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--cdnumber <replaceable>no</replaceable></option>
        </term>
        <listitem>
          <para>Choose the CD-ROM drive number.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f <replaceable>file</replaceable></option>
          <option>--font <replaceable>file</replaceable></option>
        </term>
        <listitem>
          <para>Set a TTF font file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--registry <replaceable>file</replaceable></option>
        </term>
        <listitem>
          <para>Set a registry file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--dll <replaceable>file</replaceable></option>
        </term>
        <listitem>
          <para>Set a dll file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-r <replaceable>path</replaceable></option>
          <option>--root <replaceable>path</replaceable></option>
        </term>
        <listitem>
          <para>Set the root path to the archives.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--fullscreen</option>
        </term>
        <listitem>
          <para>Start in fullscreen mode.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--window</option>
        </term>
        <listitem>
          <para>Start in window mode.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--force-button-shortcut</option>
        </term>
        <listitem>
          <para>Ignore useescspc and getenter command.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--enable-wheeldown-advance</option>
        </term>
        <listitem>
          <para>Advance the text on mouse wheeldown event.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--disable-rescale</option>
        </term>
        <listitem>
          <para>Do not rescale the images in the archives when compiled with -DPDA.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--edit</option>
        </term>
        <listitem>
          <para>Enable editing the volumes and the variables when 'z' is pressed.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--key-exe <replaceable>file</replaceable></option>
        </term>
        <listitem>
          <para>Set a file (*.EXE) that includes a key table.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>
          <option>--version</option>
        </term>
        <listitem>
          <para>Show version of program.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>EXAMPLE</title>

    <para>After decompressing the game data directory, we call it /path/foo for convient, please use the follow command to perform the game:</para>
<para><command>onscripter -r /path/foo</command></para>

    <para> If the game is not containing default.ttf, we can use -f to assign one as following:
    </para>
<para><command>onscripter -r /path/foo -f /usr/share/fonts/truetype/vlgothic/VL-Gothic-Regular.ttf</command></para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->