mirror of
				https://github.com/asterisk/asterisk.git
				synced 2025-11-04 05:15:22 +00:00 
			
		
		
		
	add man pages for autosupport and safe_asterisk scripts (bug #4642)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6026 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
		
							
								
								
									
										2
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								Makefile
									
									
									
									
									
								
							@@ -580,6 +580,8 @@ bininstall: all
 | 
			
		||||
	install -m 644 keys/freeworlddialup.pub $(DESTDIR)$(ASTVARLIBDIR)/keys
 | 
			
		||||
	install -m 644 asterisk.8.gz $(DESTDIR)$(ASTMANDIR)/man8
 | 
			
		||||
	install -m 644 contrib/scripts/astgenkey.8 $(DESTDIR)$(ASTMANDIR)/man8
 | 
			
		||||
	install -m 644 contrib/scripts/autosupport.8 $(DESTDIR)$(ASTMANDIR)/man8
 | 
			
		||||
	install -m 644 contrib/scripts/safe_asterisk.8 $(DESTDIR)$(ASTMANDIR)/man8
 | 
			
		||||
	if [ -d contrib/firmware/iax ]; then \
 | 
			
		||||
		install -m 644 contrib/firmware/iax/iaxy.bin $(DESTDIR)$(ASTVARLIBDIR)/firmware/iax/iaxy.bin; \
 | 
			
		||||
	else \
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										41
									
								
								contrib/scripts/autosupport.8
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										41
									
								
								contrib/scripts/autosupport.8
									
									
									
									
									
										Executable file
									
								
							@@ -0,0 +1,41 @@
 | 
			
		||||
.TH AUTOSUPPORT 8 "Jul 5th, 2005" "Asterisk" "Linux Programmer's Manual"
 | 
			
		||||
.SH NAME
 | 
			
		||||
.B autosupport
 | 
			
		||||
\(em interactive script to provide Digium[tm]'s support with information
 | 
			
		||||
.SH SYNOPSIS
 | 
			
		||||
.PP 
 | 
			
		||||
.B autosupport
 | 
			
		||||
 | 
			
		||||
.SH DESCRIPTION
 | 
			
		||||
.B autoasupport
 | 
			
		||||
is a script that is normally run by a user contacting Digium's support 
 | 
			
		||||
to automate gathering support information.
 | 
			
		||||
 | 
			
		||||
It will probe the system for some configuration and run-time information, 
 | 
			
		||||
and will also prompt the user for some optional access information (IP 
 | 
			
		||||
address, login and password).
 | 
			
		||||
 | 
			
		||||
The information is written to /root/digiuminfo which the user is expected 
 | 
			
		||||
to attach to a support ticket to Digium.
 | 
			
		||||
 | 
			
		||||
The script must be run as root as it reads Asterisk's configuration and 
 | 
			
		||||
the disk information using hdparm(8).
 | 
			
		||||
 | 
			
		||||
.SH FILES
 | 
			
		||||
.B /root/digiuminfo
 | 
			
		||||
.RS
 | 
			
		||||
The output of the script goes there
 | 
			
		||||
.RE
 | 
			
		||||
 | 
			
		||||
.SH SEE ALSO
 | 
			
		||||
asterisk(8)
 | 
			
		||||
 | 
			
		||||
.SH "AUTHOR" 
 | 
			
		||||
autosupport was written by John Bigelow <support@digium.com>.
 | 
			
		||||
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. 
 | 
			
		||||
							
								
								
									
										62
									
								
								contrib/scripts/safe_asterisk.8
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										62
									
								
								contrib/scripts/safe_asterisk.8
									
									
									
									
									
										Executable file
									
								
							@@ -0,0 +1,62 @@
 | 
			
		||||
.TH SAFE_ASTERISK 8 "Jun 30th, 2005" "Asterisk" "Linux Programmer's Manual"
 | 
			
		||||
.SH NAME
 | 
			
		||||
.B safe_asterisk
 | 
			
		||||
\(em A wrapper to run the asterisk executable in a loop
 | 
			
		||||
.SH SYNOPSIS
 | 
			
		||||
.PP 
 | 
			
		||||
.B safe_asterisk
 | 
			
		||||
.I [ asterisk_params ]
 | 
			
		||||
 | 
			
		||||
.SH DESCRIPTION
 | 
			
		||||
.B safe_asterisk 
 | 
			
		||||
is a script that runs asterisk in a loop, which can be useful if you 
 | 
			
		||||
fear asterisk may crash.
 | 
			
		||||
 | 
			
		||||
The script does not run in the background like a standard service. Rather, 
 | 
			
		||||
it runs in its own linux virtual console (9, by default).
 | 
			
		||||
It also uses the option '-c' of asterisk(8) to avoid detaching asterisk 
 | 
			
		||||
from that terminal.
 | 
			
		||||
 | 
			
		||||
safe_asterisk also runs asterisk with unlimited core file size, and thus 
 | 
			
		||||
asterisk will dump core in case of a crash.
 | 
			
		||||
 | 
			
		||||
To get a "picture" of console 9, from another terminal (e.g: from a 
 | 
			
		||||
remote shell session) you can use:
 | 
			
		||||
 | 
			
		||||
  screendump 9
 | 
			
		||||
 | 
			
		||||
The init script of the Debian package should be able to run safe_asterisk 
 | 
			
		||||
as the asterisk service, if so configured. See coments in 
 | 
			
		||||
/etc/default/asterisk
 | 
			
		||||
 | 
			
		||||
.SH FILES
 | 
			
		||||
.B /tmp
 | 
			
		||||
.RS
 | 
			
		||||
safe_asterisk runs in that directory, rather than in / as usual.
 | 
			
		||||
.RE
 | 
			
		||||
 | 
			
		||||
.B /tmp/core
 | 
			
		||||
.RS
 | 
			
		||||
If core files were generated there, they may be 
 | 
			
		||||
.RE
 | 
			
		||||
 | 
			
		||||
.SH BUGS
 | 
			
		||||
While showing the output on a console is useful, using screen(1) as 
 | 
			
		||||
the terminal may be better.
 | 
			
		||||
 | 
			
		||||
The script does not read configuration from standard location under /etc
 | 
			
		||||
 | 
			
		||||
It uses fixed locations under /tmp , and thus may be exposed to a 
 | 
			
		||||
symlink attacks.
 | 
			
		||||
 | 
			
		||||
.SH SEE ALSO
 | 
			
		||||
asterisk(8), screendump(9)
 | 
			
		||||
 | 
			
		||||
.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. 
 | 
			
		||||
		Reference in New Issue
	
	Block a user