safe_asterisk: Cleanup and debian compatibility.
[asterisk/asterisk.git] / contrib / scripts / autosupport.8
1 .TH AUTOSUPPORT 8 "Dec 14th, 2011" "autosupport" "Linux Programmer's Manual"
2 .SH NAME
3 .B autosupport
4 \(em interactive script to provide Digium[tm]'s support with information
5 .SH SYNOPSIS
6 .PP 
7 .B autosupport [OPTION] [prefix]
8
9 .SH DESCRIPTION
10 \fBautosupport\fR is a script that is normally run by a user contacting Digium's Technical
11 Support to automate gathering support information. It will probe the
12 system for some run\-time and system information, and generate a backup
13 of Asterisk related configuration. An optional parameter for a prefix
14 may be specified which is typically used to specify a Digium Technical
15 Support Ticket ID.
16 .PP 
17 The script requires root privileges to run, and writes all output in the 
18 home directory of the user running the script. For the purposes of this 
19 document, this will be referred to as /root/ henceforth.
20 .PP 
21 The system information is written to /root/digiuminfo.txt and the backup
22 of configuration (and the system information file) are written to a tarball
23 in /root/ with a base name of digium\-info. A Date Stamp will be appended,
24 and if specified the optional parameter will be a prefix. The tarball at
25 least is expected to be attached to a support ticket with Digium.
26
27 .SH OPTIONS
28 .SS Arguments:
29 .TP 15
30 \fBprefix\fR
31 Used to prefix the file names. Typically a Digium Technical Support Ticket ID
32 .SS Options:
33 .TP 25
34 \fB\-n, \-\-non-interactive\fR
35 Run without requiring user input
36 .TP 25
37 \fB\-h, \-\-help\fR
38 Show help about options
39 .SH FILES
40 .B /root/digiuminfo.txt
41 .br 
42 .B /root/digium\-info_YYYYMMDD.tar.gz
43
44 .SH SEE ALSO
45 asterisk(8)
46
47 .SH AUTHOR
48 autosupport was written by John Bigelow <support@digium.com> in conjunction with
49 Charles Moye and Trey Blancher. This manual page was written by
50 Tzafrir Cohen <tzafrir.cohen@xorcom.com> and updated by Charles Moye. Permission
51 is granted to copy, distribute and/or modify this document under the terms of
52 the GNU General Public License, Version 2 any later version published by the
53 Free Software Foundation. 
54 .PP 
55 On Debian systems, the complete text of the GNU General Public 
56 License can be found in /usr/share/common\-licenses/GPL\-2.