Annotation of embedaddon/coova-chilli/doc/chilli_query.1.in, revision 1.1
1.1 ! misho 1: .\" * chilli_query
! 2: .\" * Copyright (C) 2007 David Bird <david@coova.com>
! 3: .\" *
! 4: .\" * All rights reserved.
! 5: .\" *
! 6: .\" Manual page for chilli_query
! 7: .\" SH section heading
! 8: .\" SS subsection heading
! 9: .\" LP paragraph
! 10: .\" IP indented paragraph
! 11: .\" TP hanging label
! 12:
! 13: .TH chilli_query 1 "August 2007"
! 14: .SH NAME
! 15: chilli_query \- Interface into the chilli server
! 16:
! 17: .SH SYNOPSIS
! 18: .B chilli_query
! 19: [ \-s <unix-socket> ] list
! 20:
! 21: .B chilli_query
! 22: [ \-s <unix-socket> ] authorize <parameters>
! 23:
! 24: .B chilli_query
! 25: [ \-s <unix-socket> ] logout <client-mac-address>
! 26:
! 27: .SH DESCRIPTION
! 28: .B chilli_query
! 29: is an interface into the running
! 30: .B chilli
! 31: server. It provides an administrator the ability to see who is logged in, to
! 32: force a client to be logged out, or force a client to be authorized.
! 33:
! 34: Commands:
! 35:
! 36: .TP
! 37: .BI list
! 38: To list all connected clients (subscribers) providing the MAC Address, IP
! 39: Address, internal chilli state (dnat, pass, etc), the session id (used in
! 40: Acct-Session-ID), authenticated status (1 authorized, 0 not), user-name used
! 41: during login, duration / max duration, idle time / max idle time, and the
! 42: original URL.
! 43:
! 44: .TP
! 45: .BI authorize " <parameters>"
! 46: To explicity authorize a client, or change the session parameters of an already
! 47: authorized client, by setting a series of session parameters.
! 48:
! 49: .RS
! 50: .I PARAMETERS
! 51: .TP
! 52: .BI ip " <ip-address>"
! 53: Select the session to be authorized by the IP address using this option (may
! 54: be used with the option below)
! 55:
! 56: .TP
! 57: .BI sessionid " <session-id>"
! 58: Select the session to be authorized by the Session-ID (may be used with the
! 59: above option)
! 60:
! 61: .TP
! 62: .BI username " <username>"
! 63: Sets the username of the session.
! 64:
! 65: .TP
! 66: .BI sessiontimeout " <seconds>"
! 67: Sets the max session time of the session.
! 68:
! 69: .TP
! 70: .BI maxoctets " <number-of-bytes>"
! 71: Sets the max data limit of the session.
! 72:
! 73: .TP
! 74: .BI maxbwup " <bandwidth>"
! 75: Sets the max up bandwidth of the session.
! 76:
! 77: .TP
! 78: .BI maxbwdown " <bandwidth>"
! 79: Sets the max down bandwidth of the session.
! 80:
! 81: .RE
! 82:
! 83: .TP
! 84: .BI logout " <client-mac-address>"
! 85: Logout and releases the DHCP lease of a client explicitly based on the MAC
! 86: address (gotten from a list command).
! 87:
! 88: .SH EXAMPLES
! 89:
! 90: # chilli_query list
! 91: .RE
! 92: 00:0D:XX:XX:XX:XX 10.1.0.3 dnat 46c83f70000 0 - 0/0 0/0 http://url.com
! 93:
! 94: # chilli_query authorize ip 10.1.0.3 sessiontimeout 60 username me
! 95: .RE
! 96:
! 97: # chilli_query list
! 98: .RE
! 99: 00:0D:XX:XX:XX:XX 10.1.0.3 pass 46c83f70000 1 me 2/0 2/0 http://url.com
! 100:
! 101: # chilli_query logout 00:0D:XX:XX:XX:XX
! 102: .RE
! 103:
! 104: # chilli_query list | awk \(aq{
! 105: if ($5 == 1) {
! 106: print "User " i++
! 107: print " MAC: " $1
! 108: print " IP Address: " $2
! 109: print " Session ID: " $4
! 110: print " User URL: " $6
! 111: print " Duration / Max: " $7
! 112: print " Idle / Max: " $8
! 113: }
! 114: }\(aq
! 115: .RE
! 116: User 1
! 117: MAC: 00-11-XX-XX-XX-XX
! 118: IP Address: 10.1.0.2
! 119: Session ID: 46fd423c00000001
! 120: User URL: http://www.yahoo.com/
! 121: Duration / Max: 219/0
! 122: Idle / Max: 3/0
! 123:
! 124:
! 125: .SH FILES
! 126: .I @VARRUN@/chilli.sock
! 127: .RS
! 128: UNIX socket used to daemon communication.
! 129: .RE
! 130:
! 131: .SH "SEE ALSO"
! 132: .BR chilli(8)
! 133: .BR chilli.conf(5)
! 134:
! 135: .SH NOTES
! 136: .LP
! 137:
! 138: See
! 139: .I http://coova.org/
! 140: for further documentation and community support.
! 141: The original ChilliSpot project homepage is/was at www.chillispot.org.
! 142:
! 143: .SH AUTHORS
! 144:
! 145: David Bird <david@coova.com>.
! 146: CoovaChilli and ChilliSpot are licensed under the Gnu Public License.
! 147:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>