File: mldonkey_command.xml

package info (click to toggle)
mldonkey 2.8.1-2etch1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 16,940 kB
  • ctags: 26,220
  • sloc: ml: 138,666; sh: 15,368; cpp: 12,076; ansic: 8,243; asm: 3,858; xml: 3,367; perl: 1,831; makefile: 259; python: 258
file content (112 lines) | stat: -rw-r--r-- 2,720 bytes parent folder | download
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
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
"/usr/share/sgml/docbook/dtd/xml/4.2/docbookx.dtd" [
  <!ENTITY debian      "Debian GNU/Linux">
  <!ENTITY dhprg       "<command>mldonkey_command</command>">
  <!ENTITY license SYSTEM "license.xml">
  <!ENTITY refentryinfo SYSTEM "refentry.xml">
]>

<refentry>

&refentryinfo;

<refmeta>
	<refentrytitle>MLDONKEY_COMMAND</refentrytitle>
	<manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
	<refname>&dhprg;</refname>

	<refpurpose>a wrapper to send command to a <command>mlnet</command> server.</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
	&dhprg; 
	<arg>options</arg>
	<arg choice="req" rep="repeat">"mlnet command"</arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

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

	<para>This manual page was written for the &debian; distribution
	because the original program is &debian; specific.</para>

	<para>This program allow you to send command to a mlnet instance. The
	idea is to provide a simple script to do batch job with mlnet</para>

</refsect1>

<refsect1>
	
	<title>OPTIONS</title>

	<variablelist>
	<varlistentry>
		<term><option>-P</option></term>
		<listitem>
			<para>Port of the telnet mldonkey server. By default 4000</para>
	</listitem>
	</varlistentry>
	<varlistentry>
		<term><option>-h</option></term>
		<listitem>
			<para>Host of the telnet mldonkey server. By default localhost</para>
		</listitem>
	</varlistentry>
	<varlistentry>
		<term><option>-u</option></term>
		<listitem>
			<para>Username to use while connecting. By default admin</para>
		</listitem>
	</varlistentry>
	<varlistentry>
		<term><option>-p</option></term>
		<listitem>
			<para>Password to use while connecting. If none is specified, ask it on stdin</para>
		</listitem>
	</varlistentry>
	<varlistentry>
		<term><option>-q</option></term>
		<listitem>
			<para>Run without displaying command result</para>
		</listitem>
	</varlistentry>
	<varlistentry>
		<term><option>-s</option></term>
		<listitem>
			<para>Use stdin to enter command</para>
		</listitem>
	</varlistentry>
	<varlistentry>
		<term><option>-v</option></term>
		<listitem>
			<para>Display login information</para>
		</listitem>
	</varlistentry>
	<varlistentry>
		<term><option>"mlnet commands"</option></term>
		<listitem>
		  <para>Any commands you can type in a telnet session connected
		  to mlnet. Try "&dhprg; longhelp" to see a complete listing.</para>
		</listitem>
	</varlistentry>
	</variablelist>

</refsect1>
	
&license;

<refsect1>
	<title>SEE ALSO</title>

	<para>mlnet <manvolnum>1</manvolnum></para>
</refsect1>

</refentry>