From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Fri, 27 Nov 2009 08:26:15 +0000 (+0100)
Subject: ros(1): Added manpage for “ros”.
X-Git-Tag: librouteros-0.2.0~7
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=fd438c2e4c0db2c5aa3a4c9de585eb263771b04b;p=routeros-api.git

ros(1): Added manpage for “ros”.
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index bbb53dd..b9c1d16 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,5 +1,5 @@
-man_PODS = librouteros.pod
-man_MANS = librouteros.3
+man_PODS = librouteros.pod ros.pod
+man_MANS = librouteros.3 ros.1
 
 EXTRA_DIST = $(man_MANS) $(man_PODS)
 
diff --git a/doc/ros.pod b/doc/ros.pod
new file mode 100644
index 0000000..486193b
--- /dev/null
+++ b/doc/ros.pod
@@ -0,0 +1,64 @@
+=head1 NAME
+
+ros - Command line utility to list information from RouterOS devices
+
+=head1 SYNOPSIS
+
+  ros [options] <host> <command> [arguments]
+
+=head1 DESCRIPTION
+
+B<ros> is a command line utility which uses I<librouteros> to connect to a
+device running RouterOS and issue a command on the device. The result is
+received and displayed on standard output. The tool was initially written as a
+simple test application for librouteros but may evolve into something usable.
+
+=head1 OPTIONS
+
+The following options are understood:
+
+=over 4
+
+=item B<-u> I<username>
+
+Use I<username> when authenticating rather than "admin", the default.
+
+=item B<-h>
+
+Display some usage information and exit.
+
+=back
+
+=head1 COMMANDS
+
+You can use one of two possibilities to issue commands. I<Generic commands>
+start with a slash and follow the low-level syntax closely. For example:
+
+  ros router.example.com '/ip/address/print'
+
+Besides this generic approach, I<ros> can also handle the high-level interfaces
+provided by librouteros. Currently the following special "built-in" commands
+are available:
+
+=over 4
+
+=item B<interface>
+
+Display information about each interface, including byte counters.
+
+=item B<registration-table>
+
+Display information about current wireless connections.
+
+=back
+
+=head1 LICENSE
+
+I<ros> is licensed under the GPLv2. No other version of the license is applicable.
+
+=head1 AUTHOR
+
+I<ros> is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
+Its homepage can be found at L<http://verplant.org/librouteros/>.
+
+(c) 2009 by Florian octo Forster.