- added pptp support (bug #18407)
[opensuse:smpppd.git] / doc / cinternet.1
1 .TH CINTERNET 1 "December 2002" "SuSE" "SMPPPD"
2 .SH NAME
3 cinternet \- simple frontend for smpppd
4 .SH DESCRIPTION
5 .B cinternet
6 is a simple frontend for the
7 .B smpppd.
8 .SH OPTIONS
9 These options are recognized by
10 .BR cinternet .
11 If a long option shows an argument as mandatory, then it is mandatory
12 for the equivalent short option also.
13 .sp
14 The order of the options is relevant except for the --verbose, --only-local,
15 --version and --help options.
16 .TP
17 .I -I, --interface-list
18 List all configured interfaces of the smpppd. The interfaces are also marked
19 either with `u' or `d' for their status of up or down respectively. The
20 interface names are utf-8 encoded.
21 .TP
22 .I -i, --interface-name=NAME
23 Specify a interface. A interface must be specified for most of the options
24 below. This option must be given before any option that requires an interface.
25 The name must exactly match one of the interface list.
26 .TP
27 .I --interface-number=NUM
28 Specify a interface. A interface must be specified for most of the options
29 below. This option must be given before any option that requires an interface.
30 The numbers start at one.
31 .TP
32 .I -P, --provider-list
33 List all configured providers for the specified interface. The currently
34 active provider is prefixed by a `a', all others by a `i'. The provider
35 names are utf-8 encoded.
36 .TP
37 .I -p, --provider-name=NAME
38 Select the active provider for the specified interface by name. The name
39 must exactly match one of the provider list. Only works when the interface
40 is down.
41 .TP
42 .I --provider-number=NUM
43 Select the active provider for the specified interface by number. The numbers
44 start at one. Only works when the interface is down.
45 .TP
46 .I -A, --start
47 Start the specified interface.
48 .TP
49 .I -D, --dialin
50 Trigger dialin for the specified interface. The interface must be in dial on
51 demand mode and already started. Not implemented for all connection types.
52 .TP
53 .I -H, --hangup
54 Trigger hangup for the specified interface. The interface must be in dial on
55 demand mode. Not implemented for all connection types.
56 .TP
57 .I -O, --stop
58 Stop the specified interface.
59 .TP
60 .I -s, --status
61 Display the status of the specified interface.
62 .TP
63 .I -c, --config
64 Display the configuration of the specified interface.
65 .TP
66 .I -l, --log
67 Displays the log of the specified interface.
68 .TP
69 .I -d, --debug={on,off}
70 Turn debugging mode of the smpppd on or off. This does not affect
71 connections already up.
72 .TP
73 .I -L, --main-conifg
74 List the main config of the smpppd.
75 .TP
76 .I -L, --main-log
77 List the main log, the log containing general informations not specific to an
78 interface, of the smpppd.
79 .TP
80 .I -v, --verbose
81 Be more verbose.
82 .TP
83 .I -o, --only-local
84 Only connect to local smpppd.
85 .TP
86 .I --script[=STYLE]
87 Format output for script. Known styles are c and sh.
88 .TP
89 .I --version
90 Show program version and exit.
91 .TP
92 .I --help
93 Show help information and exit.
94 .SH FILES
95 .TP
96 .BR /etc/smpppd-c.conf
97 Contains information about remote smpppd.
98 .TP
99 .BR /var/run/smpppd/control
100 Socket to communicate with local smpppd.
101 .SH SEE ALSO
102 .BR kinternet,
103 .BR qinternet,
104 .BR accounting (1),
105 .BR smpppd-c.conf (5),
106 .BR smpppd (8).
107 .SH AUTHOR
108 Arvin Schnell <arvin@suse.de>