add man pages (bug #4515)
authorKevin P. Fleming <kpfleming@digium.com>
Fri, 24 Jun 2005 03:02:55 +0000 (03:02 +0000)
committerKevin P. Fleming <kpfleming@digium.com>
Fri, 24 Jun 2005 03:02:55 +0000 (03:02 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@5999 65c4cc65-6c06-0410-ace0-fbb531ad65f3

contrib/scripts/astgenkey.8 [new file with mode: 0755]
utils/astman.1 [new file with mode: 0755]

diff --git a/contrib/scripts/astgenkey.8 b/contrib/scripts/astgenkey.8
new file mode 100755 (executable)
index 0000000..6dc793e
--- /dev/null
@@ -0,0 +1,129 @@
+.\" $Header$
+.\"
+.\"    transcript compatibility for postscript use.
+.\"
+.\"    synopsis:  .P! <file.ps>
+.\"
+.de P!
+.fl
+\!!1 setgray
+.fl
+\\&.\"
+.fl
+\!!0 setgray
+.fl                    \" force out current output buffer
+\!!save /psv exch def currentpoint translate 0 0 moveto
+\!!/showpage{}def
+.fl                    \" prolog
+.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
+\!!psv restore
+.
+.de pF
+.ie     \a\\*(f1\a\a .ds f1 \\n(.f
+.el .ie \a\\*(f2\a\a .ds f2 \\n(.f
+.el .ie \a\\*(f3\a\a .ds f3 \\n(.f
+.el .ie \a\\*(f4\a\a .ds f4 \\n(.f
+.el .tm ? font overflow
+.ft \\$1
+..
+.de fP
+.ie     !\a\\*(f4\a\a \{\
+.      ft \\*(f4
+.      ds f4\"
+'      br \}
+.el .ie !\a\\*(f3\a\a \{\
+.      ft \\*(f3
+.      ds f3\"
+'      br \}
+.el .ie !\a\\*(f2\a\a \{\
+.      ft \\*(f2
+.      ds f2\"
+'      br \}
+.el .ie !\a\\*(f1\a\a \{\
+.      ft \\*(f1
+.      ds f1\"
+'      br \}
+.el .tm ? font underflow
+..
+.ds f1\"
+.ds f2\"
+.ds f3\"
+.ds f4\"
+'\" t 
+.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n  
+.TH ASTGENKEY 8 "May 14th, 2005" "Asterisk" "Linux Programmer's Manual"
+.SH NAME
+.B astgenkey
+-- generates keys for for Asterisk IAX2 RSA authentication
+.SH SYNOPSIS
+.PP 
+.B astgenkey
+[ -q ] [ -n ] [ \fIkeyname\fP ]
+
+.SH DESCRIPTION
+.B genzaptelconf 
+This script generates an RSA private and public key pair in PEM format 
+for use by Asterisk.  The private key should be kept a secret, as it can 
+be used to fake your system's identity.  Thus by default (without the 
+option 
+.I -n
+) the script will create a passphrase-encrypted copy of your secret key: 
+without entering the passphrase you won't be able to use it. 
+
+However if you want to use such a key with Asterisk, you'll have to start 
+it interactively, because the scripts that start asterisk can't use that
+encrypted key.
+
+The key is identified by a name. If you don't write the name on the 
+command-line you'll be prompted for one. The outputs of the script are:
+
+.I name\fB.pub
+.RS
+The public key: not secret. Send this to the other side.
+.RE
+
+.I name\fB.key
+.RS
+The private key: secret.
+.RE
+
+Those files should be copied to 
+.I /var/lib/asterisk/keys
+
+(The private key: on your system. The public key: on other systems)
+
+To see the currently-installed keys from the asterisk CLI, use the command
+
+.RS
+show keys
+.RE
+
+.SH OPTIONS
+.B -q
+.RS
+Run quietly.
+.RE
+
+.B -n
+.RS
+Don't encrypt the private key.
+.RE
+
+.SH FILES
+.I /var/lib/asterisk/keys
+.RS
+.RE
+
+.SH "SEE ALSO" 
+asterisk(8), genrsa(1), rsa(1), 
+
+http://www.voip-info.org/wiki-Asterisk+iax+rsa+auth
+
+.SH "AUTHOR" 
+This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> 
+Permission is granted to copy, distribute and/or modify this document under 
+the terms of the GNU General Public License, Version 2 any  
+later version published by the Free Software Foundation. 
+
+On Debian systems, the complete text of the GNU General Public 
+License can be found in /usr/share/common-licenses/GPL. 
diff --git a/utils/astman.1 b/utils/astman.1
new file mode 100755 (executable)
index 0000000..6a36ca4
--- /dev/null
@@ -0,0 +1,102 @@
+.\" $Header$
+.\"
+.\"    transcript compatibility for postscript use.
+.\"
+.\"    synopsis:  .P! <file.ps>
+.\"
+.de P!
+.fl
+\!!1 setgray
+.fl
+\\&.\"
+.fl
+\!!0 setgray
+.fl                    \" force out current output buffer
+\!!save /psv exch def currentpoint translate 0 0 moveto
+\!!/showpage{}def
+.fl                    \" prolog
+.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
+\!!psv restore
+.
+.de pF
+.ie     \a\\*(f1\a\a .ds f1 \\n(.f
+.el .ie \a\\*(f2\a\a .ds f2 \\n(.f
+.el .ie \a\\*(f3\a\a .ds f3 \\n(.f
+.el .ie \a\\*(f4\a\a .ds f4 \\n(.f
+.el .tm ? font overflow
+.ft \\$1
+..
+.de fP
+.ie     !\a\\*(f4\a\a \{\
+.      ft \\*(f4
+.      ds f4\"
+'      br \}
+.el .ie !\a\\*(f3\a\a \{\
+.      ft \\*(f3
+.      ds f3\"
+'      br \}
+.el .ie !\a\\*(f2\a\a \{\
+.      ft \\*(f2
+.      ds f2\"
+'      br \}
+.el .ie !\a\\*(f1\a\a \{\
+.      ft \\*(f1
+.      ds f1\"
+'      br \}
+.el .tm ? font underflow
+..
+.ds f1\"
+.ds f2\"
+.ds f3\"
+.ds f4\"
+'\" t 
+.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n  
+.TH ASTMAN 1 "Jun 12th, 2005" "astman" "Linux Programmer's Manual"
+.SH NAME
+.B astman
+-- a client to asterisk's manager interface
+.SH SYNOPSIS
+.PP 
+.B astman
+.I hostname
+
+.SH DESCRIPTION
+.B astman
+This program is a full-screen (terminal) client for Asterisk's manager
+interface.
+
+.SH OPTIONS
+.B hostname
+
+The host name or IP address to connect to (TCP port 5038). If astman 
+fails to connect it will exit immidiately.
+
+.SH USAGE
+If \fBastman\fR has successfully cunnected to the manager port it will 
+prompt the user for a username and a secret (password) for the manager 
+interface on the remote Asterisk manager interface. It will then be able 
+to report existing channels (calls). You will then be able to redirect 
+calls to or terminate them.
+
+.SH "SEE ALSO" 
+asterisk(8)
+
+http://www.voip-info.org/wiki-Asterisk+astman
+
+.SH BUGS
+The hostname does not default to localhost.  
+
+Impossible to use a port other than 5038.
+
+The username and password cannot be defined from the command-line.
+
+I mean, what's the point in a man page if the syntax is so simple?
+
+.SH "AUTHOR" 
+This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> 
+Permission is granted to copy, distribute and/or modify this document under 
+the terms of the GNU General Public License, Version 2 any  
+later version published by the Free Software Foundation. 
+
+On Debian systems, the complete text of the GNU General Public 
+License can be found in /usr/share/common-licenses/GPL.