xref: /freebsd/usr.sbin/uhsoctl/uhsoctl.1 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\" Copyright (c) 2008-2009 Fredrik Lindberg
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23.\"
24.\" $FreeBSD$
25.\"
26.Dd August 12, 2009
27.Dt UHSOCTL 1
28.Os
29.Sh NAME
30.Nm uhsoctl
31.Nd connection utility for Option based devices
32.Sh SYNOPSIS
33.Nm
34.Op Fl a Ar apn
35.Op Fl c Ar cid
36.Op Fl p Ar pin
37.Op Fl u Ar username
38.Op Fl k Ar password
39.Op Fl r Ar path
40.Op Fl f Ar path
41.Op Fl b | n
42.Ar interface
43.Nm
44.Fl d
45.Ar interface
46.Nm
47.Fl h
48.Sh DESCRIPTION
49.Nm
50is a small connection utility for Option N.V. devices that are based on Options
51packet interface and uses proprietary AT_* calls to establish connections.
52The utility (tries to) configure both default route and name servers
53.Po Pa /etc/resolv.conf Pc .
54.Pp
55By default
56.Nm
57detaches from the terminal upon on a successful connection, a few command-line
58options exists that allows this behavior to be changed.
59.Pp
60.Nm
61attempts to find a usable controlling serial port based on the provided network
62interface.
63If this fails you might specify a serial port manually.
64.Sh OPTIONS
65.Bl -tag -width XXXX
66.It Fl a Ar apn
67Specify APN to connect to.
68.It Fl c Ar cid
69Specify CID (Context ID) to use, by default CID 1 is used.
70If an APN has been configured once, it's enough to specify the CID used for
71further accesses.
72.It Fl p Ar pin
73Specify SIM PIN.
74.It Fl u Ar username
75Specify username.
76.It Fl k Ar password
77Specify username.
78.It Fl r Ar path
79Path to
80.Pa resolv.conf ,
81default
82.Pa /etc/resolv.conf .
83Use
84.Pa /dev/null
85to disable updating of name servers.
86.It Fl f Ar path
87Explicitly set the serial port to use as controlling terminal.
88Might be needed if the automatic detection fails.
89.It Fl b
90Fork into background directly, before a connection has been established.
91.It Fl n
92Never fork into background, run entirely in foreground.
93.El
94.Sh EXAMPLES
95Connect to
96.Dq Li apn.example.com
97on interface
98.Dq Li uhso0
99and use PIN
100.Dq 1234
101to enable the SIM card.
102.Dl "uhsoctl -a apn.example.com -p 1234 uhso0"
103.Pp
104Disconnect from a previously established connection.
105.Dl "uhsoctl -d uhso0"
106.Sh SEE ALSO
107.Xr uhso 4
108