Further work on Barry USB channel relaying. This is mostly just adding debug output...
[barry.git] / man / pppob.1
blobd6258f8c09216231af10cf761b356c2197d32454
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH PPPOB 1 "May 29, 2008"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 .B pppob
20 \- Barry Project's program to access the Blackberry modem for pppd
21 .SH SYNOPSIS
22 .B pppob
23 [-l filename][-p pin][-P password][-s][-v]
24 .SH DESCRIPTION
25 .PP
26 .B pppob
27 is a program suitable for use in pppd's pty option file.
28 It talks to an available Blackberry and provides modem
29 access on stdin and stdout.
30 .SH OPTIONS
31 .TP
32 .B \-l filename
33 Causes verbose debug output from the -v switch to be written to
34 filename instead of stderr.
35 .TP
36 .B \-p pin
37 PIN of device to talk with.  Only needed if you have more than one Blackberry
38 connected at once.
39 .TP
40 .B \-P password
41 Simplistic method to specify device password.  In a real application, this
42 would be done using a more secure prompt.
43 .TP
44 .B \-s
45 Use Serial mode instead of the default IpModem mode.  Older Blackberries
46 used a serial mode based on a similar protocol to what database access
47 uses for retrieving data.  Each packet had a size and socket number
48 prepended to the actual modem data.  Newer Blackberries have dedicated
49 USB endpoints that behave as read/write points, and do not bother
50 with this size/socket format, and therefore transfer less data across the
51 USB bus.  By default, pppob tries to use IpModem mode if proper endpoints
52 are detected, and otherwise falls back to Serial mode.  This switch
53 skips IpModem mode entirely and tries Serial mode immediately.
54 .TP
55 .B \-v
56 Dump verbose protocol data to stderr during operation.
58 .SH AUTHOR
59 .nh
60 .B pppob
61 is part of the Barry project.
62 .SH SEE ALSO
63 .PP
64 http://www.netdirect.ca/software/packages/barry