usr.sbin/uhsoctl/uhsoctl.1

   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 .Dd August 12, 2009
  25 .Dt UHSOCTL 1
  26 .Os
  27 .Sh NAME
  28 .Nm uhsoctl
  29 .Nd connection utility for Option based devices
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl a Ar apn
  33 .Op Fl c Ar cid
  34 .Op Fl p Ar pin
  35 .Op Fl u Ar username
  36 .Op Fl k Ar password
  37 .Op Fl r Ar path
  38 .Op Fl f Ar path
  39 .Op Fl b | n
  40 .Ar interface
  41 .Nm
  42 .Fl d
  43 .Ar interface
  44 .Nm
  45 .Fl h
  46 .Sh DESCRIPTION
  47 .Nm
  48 is a small connection utility for Option N.V. devices that are based on Options
  49 packet interface and uses proprietary AT_* calls to establish connections.
  50 The utility (tries to) configure both default route and name servers
  51 .Po Pa /etc/resolv.conf Pc .
  52 .Pp
  53 By default
  54 .Nm
  55 detaches from the terminal upon on a successful connection, a few command-line
  56 options exists that allows this behavior to be changed.
  57 .Pp
  58 .Nm
  59 attempts to find a usable controlling serial port based on the provided network
  60 interface.
  61 If this fails you might specify a serial port manually.
  62 .Sh OPTIONS
  63 .Bl -tag -width XXXX
  64 .It Fl a Ar apn
  65 Specify APN to connect to.
  66 .It Fl c Ar cid
  67 Specify CID (Context ID) to use, by default CID 1 is used.
  68 If an APN has been configured once, it's enough to specify the CID used for
  69 further accesses.
  70 .It Fl p Ar pin
  71 Specify SIM PIN.
  72 .It Fl u Ar username
  73 Specify username.
  74 .It Fl k Ar password
  75 Specify username.
  76 .It Fl r Ar path
  77 Path to
  78 .Pa resolv.conf ,
  79 default
  80 .Pa /etc/resolv.conf .
  81 Use
  82 .Pa /dev/null
  83 to disable updating of name servers.
  84 .It Fl f Ar path
  85 Explicitly set the serial port to use as controlling terminal.
  86 Might be needed if the automatic detection fails.
  87 .It Fl b
  88 Fork into background directly, before a connection has been established.
  89 .It Fl n
  90 Never fork into background, run entirely in foreground.
  91 .El
  92 .Sh EXAMPLES
  93 Connect to
  94 .Dq Li apn.example.com
  95 on interface
  96 .Dq Li uhso0
  97 and use PIN
  98 .Dq 1234
  99 to enable the SIM card.
 100 .Dl "uhsoctl -a apn.example.com -p 1234 uhso0"
 101 .Pp
 102 Disconnect from a previously established connection.
 103 .Dl "uhsoctl -d uhso0"
 104 .Sh SEE ALSO
 105 .Xr uhso 4