aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakub Ružička <jakub.ruzicka@nic.cz>2022-11-30 12:30:18 +0100
committerJakub Ružička <jakub.ruzicka@nic.cz>2022-11-30 13:25:39 +0100
commit14da549b4d2359741047fc503d678122906a8c69 (patch)
tree28db33567845d7966adaae615e8f5d5ab97c4868
parente1890a181585ccaa96be67fd23edac37101a8039 (diff)
downloadbird-14da549b4d2359741047fc503d678122906a8c69.tar.gz
Extend manpage for birdcl
-rw-r--r--debian/bird.xml33
-rw-r--r--debian/bird2.lintian-overrides1
-rw-r--r--debian/bird2.manpages1
-rwxr-xr-xdebian/rules2
4 files changed, 31 insertions, 6 deletions
diff --git a/debian/bird.xml b/debian/bird.xml
index 4ba3868f..2cc69575 100644
--- a/debian/bird.xml
+++ b/debian/bird.xml
@@ -65,11 +65,23 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<email>&dhemail;</email>
</address>
</author>
+ <author>
+ <firstname>Jakub</firstname>
+ <surname>Ružička</surname>
+ <contrib>Updated this manpage for birdcl.</contrib>
+ <address>
+ <email>jakub.ruzicka@nic.cz</email>
+ </address>
+ </author>
</authorgroup>
<copyright>
<year>2010</year>
<holder>&dhusername;</holder>
</copyright>
+ <copyright>
+ <year>2022</year>
+ <holder>Jakub Ružička</holder>
+ </copyright>
<legalnotice>
<para>This manual page was written for the Debian system
(and may be used by others).</para>
@@ -95,6 +107,10 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<refname>birdc</refname>
<refpurpose>BIRD Internet Routing Daemon remote control</refpurpose>
</refnamediv>
+ <refnamediv>
+ <refname>birdcl</refname>
+ <refpurpose>BIRD Internet Routing Daemon remote control light</refpurpose>
+ </refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
@@ -118,6 +134,13 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<arg choice="opt"><option>-s <replaceable>control-socket</replaceable></option></arg>
<arg choice="opt"><option>-v</option></arg>
</cmdsynopsis>
+ <cmdsynopsis>
+ <command>birdcl</command>
+ <arg choice="opt"><option>-l</option></arg>
+ <arg choice="opt"><option>-r</option></arg>
+ <arg choice="opt"><option>-s <replaceable>control-socket</replaceable></option></arg>
+ <arg choice="opt"><option>-v</option></arg>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
@@ -136,7 +159,10 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
communicate. Once started, <command>bird</command> will give access
to an interactive shell: commands can be completed with TAB and help
can be requested by pressing the key `?'. More documentation on
- the available commands can be foung on the website, see below.</para>
+ the available commands can be found on the website, see below.</para>
+ <para><command>birdcl</command> is a light version of <command>birdc</command>
+ remote control for <command>bird</command> without readline/ncurses support.
+ TAB completion isn't available.</para>
</refsect1>
<refsect1 id="options">
@@ -230,7 +256,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
</varlistentry>
</variablelist>
- <para>The <command>birdc</command> accepts these options:</para>
+ <para><command>birdc</command> and <command>birdcl</command> accept these options:</para>
<variablelist>
<varlistentry>
<term><option>-l</option></term>
@@ -279,8 +305,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<refsect1 id="see_also">
<title>SEE ALSO</title>
- <para>More documentation con be found on the website:
+ <para>More documentation can be found on the website:
https://bird.network.cz/.</para>
</refsect1>
</refentry>
-
diff --git a/debian/bird2.lintian-overrides b/debian/bird2.lintian-overrides
deleted file mode 100644
index bf28f262..00000000
--- a/debian/bird2.lintian-overrides
+++ /dev/null
@@ -1 +0,0 @@
-bird2: no-manual-page usr/sbin/birdcl
diff --git a/debian/bird2.manpages b/debian/bird2.manpages
index 94898ea1..cd80062c 100644
--- a/debian/bird2.manpages
+++ b/debian/bird2.manpages
@@ -1,2 +1,3 @@
bird.8
birdc.8
+birdcl.8
diff --git a/debian/rules b/debian/rules
index e90b08ad..32fd6cff 100755
--- a/debian/rules
+++ b/debian/rules
@@ -47,7 +47,7 @@ override_dh_installman: bird.8
override_dh_clean:
dh_clean
- -rm -f bird.8 birdc.8
+ -rm -f bird.8 birdc.8 birdcl.8
override_dh_missing:
dh_missing