diff --git a/res/res_fax.c b/res/res_fax.c index 841d7ef7ef..159eec7cdd 100644 --- a/res/res_fax.c +++ b/res/res_fax.c @@ -59,34 +59,143 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/indications.h" #include "asterisk/ast_version.h" -static const char app_receivefax[] = "ReceiveFAX"; -static const char synopsis_receivefax[] = "Receive a FAX and save as a TIFF/F file."; -static const char descrip_receivefax[] = "ReceiveFAX(filename[,options]):\n" - " The ReceiveFAX() application receives a FAX as a TIFF/F file with specified filename.\n" - " The application arguments are:\n" - " 'd' - enables FAX debugging\n" - " 'f' - allow audio fallback FAX transfer on T.38 capable channels\n" - " 's' - send progress Manager events (overrides statusevents setting in res_fax.conf)\n" - "\n" - " Use the FAXOPT function to specify session arguments prior to calling ReceiveFAX()\n" - " and use FAXOPT after ReceiveFAX completes to query result status for the session.\n" - " The ReceiveFAX() is provided by res_fax, which is a FAX technology agnostic module\n" - " that utilizes FAX technology resource modules to complete a FAX transmission.\n"; +/*** DOCUMENTATION + + + Receive a FAX and save as a TIFF/F file. + + + + + + + + + + + + + This application is provided by res_fax, which is a FAX technology agnostic module + that utilizes FAX technology resource modules to complete a FAX transmission. + Session arguments can be set by the FAXOPT function and to check results of the ReceiveFax() application. + + + FAXOPT + + + + + Sends a specified TIFF/F file as a FAX. + + + + + TIFF file to send as a FAX. + + + + + + + + + + + + + This application is provided by res_fax, which is a FAX technology agnostic module + that utilizes FAX technology resource modules to complete a FAX transmission. + Session arguments can be set by the FAXOPT function and to check results of the SendFax() application. + + + FAXOPT + + + + + Gets/sets various pieces of information about a fax session. + + + + + + R/W Error Correction Mode (ECM) enable with 'yes', disable with 'no'. + + + R/O FAX transmission error code upon failure. + + + R/O Filename of the first file of the FAX transmission. + + + R/O Filenames of all of the files in the FAX transmission (comma separated). + + + R/W FAX header information. + + + R/W Local Station Identification. + + + R/W Minimum transfer rate set before transmission. + + + R/W Maximum transfer rate set before transmission. + + + R/W Modem type (v17/v27/v29). + + + R/O Number of pages transferred. + + + R/O Negotiated transmission rate. + + + R/O Remote Station Identification after transmission. + + + R/O Negotiated image resolution after transmission. + + + R/O Session ID of the FAX transmission. + + + R/O Result Status of the FAX transmission. + + + R/O Verbose Result Status of the FAX transmission. + + + + + + FAXOPT can be used to override the settings for a FAX session listed in res_fax.conf, + it can also be used to retreive information about a FAX session that has finished eg. pages/status. + + + ReceiveFax + SendFax + + +***/ +static const char app_receivefax[] = "ReceiveFAX"; static const char app_sendfax[] = "SendFAX"; -static const char synopsis_sendfax[] = "Sends a specified TIFF/F file as a FAX."; -static const char descrip_sendfax[] = "SendFAX(filename[&filename[&filename]][,options]):\n" - " The SendFAX() application sends the specified TIFF/F file(s) as a FAX.\n" - " The application arguments are:\n" - " 'd' - enables FAX debugging\n" - " 'f' - allow audio fallback FAX transfer on T.38 capable channels\n" - " 'z' - initiate a T.38 reinvite on the channel if the remote end does not\n" - " 's' - send progress Manager events (overrides statusevents setting in res_fax.conf)\n" - "\n" - " Use the FAXOPT function to specify session arguments prior to calling SendFAX()\n" - " and use FAXOPT after SendFAX completes to query result status for the session.\n" - " The SendFAX() application is provided by res_fax, which is a FAX technology agnostic module\n" - " that utilizes FAX technology resource modules to complete a FAX transmission.\n"; struct debug_info_history { unsigned int consec_frames; @@ -2302,35 +2411,6 @@ static int acf_faxopt_write(struct ast_channel *chan, const char *cmd, char *dat /*! \brief FAXOPT dialplan function */ struct ast_custom_function acf_faxopt = { .name = "FAXOPT", - .synopsis = "Set options for use with the SendFAX and ReceiveFAX functions, or read options after a FAX transmission completes", - .syntax = -"FAXOPT(