summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'net-misc/stargazer/files/mans')
-rw-r--r--net-misc/stargazer/files/mans/rscriptd.851
-rw-r--r--net-misc/stargazer/files/mans/sgauth.854
-rw-r--r--net-misc/stargazer/files/mans/sgconf.1160
-rw-r--r--net-misc/stargazer/files/mans/sgconf_xml.179
-rw-r--r--net-misc/stargazer/files/mans/sgconv.142
-rw-r--r--net-misc/stargazer/files/mans/stargazer.864
6 files changed, 450 insertions, 0 deletions
diff --git a/net-misc/stargazer/files/mans/rscriptd.8 b/net-misc/stargazer/files/mans/rscriptd.8
new file mode 100644
index 000000000000..440f7b0267b1
--- /dev/null
+++ b/net-misc/stargazer/files/mans/rscriptd.8
@@ -0,0 +1,51 @@
+.TH rscriptd 8 "December 31, 2012" "" "rscriptd"
+
+.SH NAME
+rscriptd \- a remote script execute daemon for Stargazer
+
+.SH SYNOPSIS
+.B rscriptd
+.RI [ config-file ]
+.br
+
+.SH DESCRIPTION
+The
+.B rscriptd
+daemon typically runs on a last-wire router before users and
+manages firewall rules to allow/disallow users get their services.
+.B rscriptd
+communicates with
+.B Stargazer
+main daemon by UDP protocol.
+
+.SH OPTIONS
+.TP
+.I config-file
+Path to rscriptd configuration file. Default is
+.B
+/etc/rscriptd/rscriptd.conf
+
+.SH FILES
+.B
+/usr/sbin/rsriptd
+.br
+.B
+/etc/stargazer/rscriptd.conf
+.br
+.B
+/var/log/stargazer/rscriptd.log
+
+.SH SEE ALSO
+.BR sgconf (1),
+.BR sgconf_xml (1),
+.BR sgconv (1),
+.BR sgauth (8),
+.BR stargazer (8).
+
+.SH AUTHOR
+rscriptd was originally written by Boris Mikhailenko <stg34@stargazer.dp.ua> and
+Maxim Mamontov <faust@stargazer.dp.ua>.
+.PP
+This manual page was written by Alexey Osipov <simba@lerlan.ru>,
+for the Debian project (and may be used by others), and was modified by
+Vladimir Pavljuchenkov <spiderx@spiderx.dp.ua> for Gentoo Linux \ No newline at end of file
diff --git a/net-misc/stargazer/files/mans/sgauth.8 b/net-misc/stargazer/files/mans/sgauth.8
new file mode 100644
index 000000000000..24c872761f7e
--- /dev/null
+++ b/net-misc/stargazer/files/mans/sgauth.8
@@ -0,0 +1,54 @@
+.TH sgauth 1 "December 31, 2012" "" "sgauth"
+
+.SH NAME
+sgauth \- a command-line utility for authorization in Stargazer
+
+.SH SYNOPSIS
+.B sgauth
+.RI [ config-file ]
+.br
+
+.SH DESCRIPTION
+.B sgauth
+allow user to become authorized in
+.B Stargazer
+billing system.
+.PP
+.B sgauth
+reads the
+.IR config-file ,
+connects to
+.B Stargazer
+server and authentificates on it using data supplied in
+.IR config-file .
+In addition, it runs a simple http-server on port 5580, capable of
+monitoring and controlling the connection (if specified in
+.IR config-file ")."
+
+.SH OPTIONS
+.TP
+.I config-file
+Path to file containing user login, password and other configuration data. Default is
+.B
+/etc/sgauth.conf
+
+.SH FILES
+.B
+/usr/sbin/sgauth
+.br
+.B
+/etc/stargazer/sgauth.conf
+
+.SH SEE ALSO
+.BR sgconf (1),
+.BR sgconf_xml (1),
+.BR sgconv (1),
+.BR stargazer (8),
+.BR rscriptd (8).
+
+.SH AUTHOR
+sgauth was initially written by Boris Mikhailenko <stg34@stargazer.dp.ua>.
+.PP
+This manual page was written by Alexey Osipov <simba@lerlan.ru>,
+for the Debian project (and may be used by others), and was modified by
+Vladimir Pavljuchenkov <spiderx@spiderx.dp.ua> for Gentoo Linux \ No newline at end of file
diff --git a/net-misc/stargazer/files/mans/sgconf.1 b/net-misc/stargazer/files/mans/sgconf.1
new file mode 100644
index 000000000000..4017d9e59648
--- /dev/null
+++ b/net-misc/stargazer/files/mans/sgconf.1
@@ -0,0 +1,160 @@
+.TH sgconf 1 "December 31, 2012" "" "sgconf"
+
+.SH NAME
+sgconf \- a command-line utility for configuring Stargazer
+
+.SH SYNOPSIS
+.B sgconf
+(
+.I get
+|
+.I set
+)
+.BI \-s " server"
+.BI \-p " port"
+.BI \-a " admin"
+.BI \-w " admin-pass"
+.BI \-u " user"
+.I special-options
+.br
+
+.SH DESCRIPTION
+.B sgconf
+allows
+.B Stargazer
+system administrators to configure users.
+.PP
+.B sgconf
+support two subset of commands -
+.I get
+and
+.IR set .
+.I get
+commands are for reading actual values from
+.B Stargazer
+and
+.I set
+commands are for writing new values to
+.BR Stargazer .
+
+.SH OPTIONS
+.TP
+.BI \-s " server"
+IP or hostname where
+.B Stargazer
+server run.
+.TP
+.BI \-p " port"
+Port, which
+.B Stargazer
+listen for configuration connections (typically 5555).
+.TP
+.BI \-a " admin"
+Administrator login.
+.TP
+.BI \-w " admin-pass"
+Administrator password.
+.TP
+.TP
+.IR special-options " are following:"
+(Use without argument for
+.IR get ")"
+.TP
+.BI \-c " add_cash[:log message]"
+Get user's balance or add money to user's balance with optional log message.
+.TP
+.BI \-v " set_cash[:log message]"
+Set user's balance with optional log message.
+.TP
+.BI \-t " tariff:now|delayed"
+Get/set user's tariff. If
+.I now
+specified, the change is immediate. If
+.I delayed
+specified, the change will happen at end of the month.
+.TP
+.BI \-r " credit"
+Get/set user's maximum credit.
+.TP
+.BI \-o " password"
+Get/set user's password.
+.TP
+.BI \-e " prepaid"
+Get/set amount of user's prepaid traffic.
+.TP
+.BI \-I " *|ip_addr[,ip_addr...]"
+Get/set user's allowed IP addresses. Asterisk mark means "any address".
+.TP
+.BI \-A " name"
+Get/set user's name.
+.TP
+.BI \-N " note"
+Get/set user's note.
+.TP
+.BI \-D " address"
+Get/set user's street address.
+.TP
+.BI \-L " email"
+Get/set user's email.
+.TP
+.BI \-P " phone"
+Get/set user's phone.
+.TP
+.BI \-G " group"
+Get/set group, user belongs to.
+.TP
+.BI \-d " 0|1"
+Get/set user's "down" ("disabled") flag.
+.TP
+.BI \-i " 0|1"
+Get/set user's "passive" ("frozen") flag.
+.TP
+.BI \-\-disable\-stat " 0|1"
+Get/set user's "disableDetailStat" flag.
+.TP
+.BI \-\-always\-online " 0|1"
+Get/set user's "alwaysOnline" flag.
+.TP
+.BI \-\-u "X traffic"
+Get/set user's upload traffic for
+.I X
+service (direction).
+.TP
+.BI \-\-d "X traffic"
+Get/set user's download traffic for
+.I X
+service (direction).
+.TP
+.BI \-\-ud "X userdata"
+Get/set user's
+.I X
+custom data.
+.TP
+.BI \-m " message"
+Send
+.I message
+to user.
+.TP
+.B \-n
+Create new user.
+.TP
+.B \-l
+Delete user.
+
+.SH FILES
+.B
+/usr/bin/sgconf
+
+.SH SEE ALSO
+.BR sgauth (8),
+.BR sgconf_xml (1),
+.BR sgconv (1),
+.BR stargazer (8),
+.BR rscriptd (8).
+
+.SH AUTHOR
+sgconf was initially written by Boris Mikhailenko <stg34@stargazer.dp.ua>.
+.PP
+This manual page was written by Alexey Osipov <simba@lerlan.ru>,
+for the Debian project (and may be used by others), and was modified by
+Vladimir Pavljuchenkov <spiderx@spiderx.dp.ua> for Gentoo Linux \ No newline at end of file
diff --git a/net-misc/stargazer/files/mans/sgconf_xml.1 b/net-misc/stargazer/files/mans/sgconf_xml.1
new file mode 100644
index 000000000000..428fadfd5b18
--- /dev/null
+++ b/net-misc/stargazer/files/mans/sgconf_xml.1
@@ -0,0 +1,79 @@
+.TH sgconf_xml 1 "December 31, 2012" "" "sgconf_xml"
+
+.SH NAME
+sgconf_xml \- a command-line xml-based utility for configuring Stargazer
+
+.SH SYNOPSIS
+.B sgconf_xml
+.BI \-s " server"
+.BI \-p " port"
+.BI \-a " admin"
+.BI \-w " admin-pass"
+(
+.BI \-r " request-string"
+|
+.BI \-f " request-file"
+)
+
+.SH DESCRIPTION
+.B sgconf_xml
+allows system administrators to configure
+.BR Stargazer .
+.PP
+.B sgconf_xml
+uses XML for requests and responses. You can specify a
+file containing XML request by using
+.B \-f
+option, or you can specify XML request directly as a
+string by using
+.B \-r
+option.
+
+.SH OPTIONS
+.TP
+.BI \-s " server"
+IP or hostname where
+.B Stargazer
+server run.
+.TP
+.BI \-p " port"
+Port, which
+.B Stargazer
+listen for configuration connections (typically 5555).
+.TP
+.BI \-a " admin"
+Administrator login.
+.TP
+.BI \-w " admin-pass"
+Administrator password.
+.TP
+.BI \-r " request-string"
+The request in form of XML.
+.TP
+.BI \-f " request-file"
+File containing request in form of XML.
+
+.SH REQUEST SYNTAX
+TODO.
+.br
+As for now you can check an example by running
+.B sgconf_xml
+without arguments.
+
+.SH FILES
+.B
+/usr/bin/sgconf_xml
+
+.SH SEE ALSO
+.BR sgauth (8),
+.BR sgconf (1),
+.BR sgconv (1),
+.BR stargazer (8),
+.BR rscriptd (8).
+
+.SH AUTHOR
+sgconf_xml was initially written by Boris Mikhailenko <stg34@stargazer.dp.ua>.
+.PP
+This manual page was written by Alexey Osipov <simba@lerlan.ru>,
+for the Debian project (and may be used by others), and was modified by
+Vladimir Pavljuchenkov <spiderx@spiderx.dp.ua> for Gentoo Linux \ No newline at end of file
diff --git a/net-misc/stargazer/files/mans/sgconv.1 b/net-misc/stargazer/files/mans/sgconv.1
new file mode 100644
index 000000000000..b5fb225ab064
--- /dev/null
+++ b/net-misc/stargazer/files/mans/sgconv.1
@@ -0,0 +1,42 @@
+.TH sgconv 1 "December 31, 2012" "" "sgconv"
+
+.SH NAME
+sgconv \- an utility to convert Stargazer data between storage backends
+
+.SH SYNOPSIS
+.B sgconv
+.RI [ config-file ]
+
+.SH DESCRIPTION
+.B sgconv
+allows system administrators to copy and merge
+.B Stargazer
+data from one storage backend to another.
+
+.SH OPTIONS
+.TP
+.I config-file
+A path to config file containing convertion parameters. Default is
+.B sgconv.conf
+in current directory.
+
+.SH FILES
+.B
+/usr/bin/sgconv
+.br
+.B
+/etc/stargazer/sgconv.conf
+
+.SH SEE ALSO
+.BR sgauth (8),
+.BR sgconf (1),
+.BR sgconf_xml (1),
+.BR stargazer (8),
+.BR rscriptd (8).
+
+.SH AUTHOR
+sgconv was initially written by Maxim Mamontov <faust@stargazer.dp.ua>.
+.PP
+This manual page was written by Alexey Osipov <simba@lerlan.ru>,
+for the Debian project (and may be used by others), and was modified by
+Vladimir Pavljuchenkov <spiderx@spiderx.dp.ua> for Gentoo Linux \ No newline at end of file
diff --git a/net-misc/stargazer/files/mans/stargazer.8 b/net-misc/stargazer/files/mans/stargazer.8
new file mode 100644
index 000000000000..a1860c5d97b9
--- /dev/null
+++ b/net-misc/stargazer/files/mans/stargazer.8
@@ -0,0 +1,64 @@
+.TH stargazer 8 "December 31, 2012" "" "stargazer"
+
+.SH NAME
+stargazer \- a powerfull billing system daemon
+
+.SH SYNOPSIS
+.B stargazer
+.RI [ config-directory ]
+.br
+
+.SH DESCRIPTION
+This manual page explains the
+.B stargazer
+daemon. This daemon address ISP user accounting and billing problems.
+.PP
+.B Stargazer
+is capable of:
+.PP
+- manage user accounts using several kinds of stores (plain files, MySQL, Firebird,
+PostgreSQL)
+.br
+- gather traffic flow information using several methods (Netflow protocol, rawsocket
+ethernet packets capture, netfilter IPQ capture)
+.br
+- bill user accounts according to rate rules and traffic classification
+.br
+- authentificate and authorize users to get access to the internet
+
+.SH OPTIONS
+.TP
+.I config-directory
+Path to directory containing stargazer configuration files. Default is
+.B
+/etc/stargazer
+
+.SH FILES
+.B
+/usr/sbin/stargazer
+.br
+.B
+/etc/stargazer/
+.br
+.B
+/var/lib/stargazer/
+.br
+.B
+/var/log/stargazer/stargazer.log
+.br
+.B
+/var/log/stargazer/xmlrpc.log
+
+.SH SEE ALSO
+.BR sgconf (1),
+.BR sgconf_xml (1),
+.BR sgconv (1),
+.BR sgauth (8),
+.BR rscriptd (8).
+
+.SH AUTHOR
+stargazer was initially written by Boris Mikhailenko <stg34@stargazer.dp.ua>.
+.PP
+This manual page was written by Alexey Osipov <simba@lerlan.ru>,
+for the Debian project (and may be used by others), and was modified by
+Vladimir Pavljuchenkov <spiderx@spiderx.dp.ua> for Gentoo Linux \ No newline at end of file