updated man page
[oweals/gnunet.git] / doc / man / gnunet-ats.1
index b84af1dc3aaa0d109c3b757f7b2522dd14ed3718..c143f7a1339f77522fdb42b727ea179a92490586 100644 (file)
@@ -1,4 +1,4 @@
-.TH GNUNET\-ATS 1 "Jan 4, 2012" "GNUnet"
+.TH GNUNET\-ATS 1 "Oct 31, 2012" "GNUnet"
 
 .SH NAME
 gnunet\-ats \- display information about transport resource allocation
@@ -9,23 +9,54 @@ gnunet\-ats \- display information about transport resource allocation
 .br
 
 .SH DESCRIPTION
-\fBgnunet\-ats\fP can be used to 
+\fBgnunet\-ats\fP can be used to display information about the GNUnet's 
+transport selection mechanism. It shows information about the 
+addresses and the assigned input and output bandwidth.
 
 .SH OPTIONS
 .B
+.IP "\-a,  \-\-aa"
+List all addresses currently known to ats.
+.B
 .IP "\-c FILENAME,  \-\-config=FILENAME"
 Use the configuration file FILENAME.
 .B
 .IP "\-h, \-\-help"
 Print short help on options.
 .B
+.IP "\-i, \-\-id=PEERID"
+Print information for a specific peer identity only
+.B
+.IP "\-k, \-\-value=VALUE"
+Value to set for when changing preference values
+.B
 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
 .B
+.IP "\-m, \-\-monitor"
+Monitor changes to the bandwidth assignments continously
+.B
+.IP "\-n, \-\-numeric"
+Do not resolve IP addresses to hostnames
+.B
+.IP "\-k, \-\-preference=E"
+Set preference values, -i, -k and -t required
+.B
+.IP "\-q, \-\-quotas"
+Print quotas for all network types
+.B
+.IP "\-t, \-\-type=VALUE"
+Preference type to change: latency | bandwidth
+.B
+.IP "\-u, \-\-used"
+Print addresses actively used only
+.B
+.IP "\-V, \-\-verbose"
+Print verbose output (include ATS address properties)
+.B
 .IP "\-v, \-\-version"
 Print GNUnet version number.
 
-
 .SH BUGS
 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org>