aereport -RePorT(1) aereport -RePorT(1) NNAAMMEE aereport -RePorT - report generator SSYYNNOOPPSSIISS aaeerreeppoorrtt [ _o_p_t_i_o_n... ] _r_e_p_o_r_t_-_n_a_m_e aaeerreeppoorrtt [ _o_p_t_i_o_n... ] --FFiillee _f_i_l_e_n_a_m_e aaeerreeppoorrtt --RReePPoorrTT --LLiisstt aaeerreeppoorrtt --HHeellpp aaeerreeppoorrtt --VVEERRSSiioonn DDEESSCCRRIIPPTTIIOONN The _a_e_r_e_p_o_r_t command is used to generate reports from aereport' database. Reports are specified in a C-like language described in the _a_e_r(5) manual entry. For a list of the reports available on your system, use the '_a_e_r _-_l_i_s_t' command. These reports live in the _/_u_s_r_/_l_o_c_a_l_/_s_h_a_r_e_/_a_e_g_i_s_/_r_e_p_o_r_t directory, and it initially contains the reports distributed with aere- port, however sites are free to add their own here. WWRRIITTIINNGG RREEPPOORRTT SSCCRRIIPPTTSS Getting started writing report scripts can be difficult. You are best to have a look at the reports distributes with Aegis, and try to adapt them. The report script files are kept in the _/_u_s_r_/_l_o_c_a_l_/_s_h_a_r_e_/_a_e_g_i_s_/_r_e_p_o_r_t directory. For information about the data structures which may be accessed from a report script, you need to see the relevant manual entries: the projects list See _a_e_g_s_t_a_t_e(1) for the member fields. a specific project See _a_e_p_s_t_a_t_e(1) for the member fields. a specific change See _a_e_c_s_t_a_t_e(1) for the member fields. a specific file See _a_e_f_s_t_a_t_e(1) for the member fields. Each of the above man pages also contains a section towards the end which specifically addresses report generator use, usually with code fragments. OOPPTTIIOONNSS The following options are understood: --BBaasseeLLiinnee This option may be used to specify that the project baseline is the subject of the command. --BBRRaanncchh _n_u_m_b_e_r This option may be used to specify a different branch for the origin file, rather than the baseline. (See also --TTRRuunnkk option. Please Note: the --BBRRaanncchh option does not take a project name, just the branch number suffix. --GGrraannddPPaarreenntt This option may be used to specify the grandparent branch (one up from the current branch) for the origin file, rather than the baseline. (The -grandparent option is the same as the "-branch .." option.) --CChhaannggee _n_u_m_b_e_r This option may be used to specify a particular change within a project. See _a_e_g_i_s(1) for a complete description of this option. --DDEELLttaa _n_u_m_b_e_r This option may be used to specify a particular delta in the project's history to copy the file from, rather than the most current version. If the delta has been given a name (see _a_e_d_n(1) for how) you may use a delta name instead of a delta number. It is an error if the delta specified does not exist. Delta numbers start from 1 and increase; delta 0 is a special case meaning "when the branch started". --DDEELLttaa__DDaattee _s_t_r_i_n_g This option may be used to specify a particular date and time in the project's history to copy the file from, rather than the most current version. It is an error if the string specified cannot be interpreted as a valid date and time. Quote the string if you need to use spaces. --DDEELLttaa__FFrroomm__CChhaannggee _n_u_m_b_e_r This option may be used to specify a particular project delta from its change number. --FFiillee _f_i_l_e_n_a_m_e Take the report script from the specified file, rather than looking for the named report in the library of reports dis- tributed with Aegis. The filename "-" is understood to mean the standard input. --HHeellpp This option may be used to obtain more information about how to use the _a_e_r_e_p_o_r_t program. --LLiisstt This option may be used to obtain a list of suitable subjects for this command. The list may be more general than expected. --OOuuttppuutt _f_i_l_e_n_a_m_e This option may be used to specify the output file. The output is sent to the standard output by default. --PPrroojjeecctt _n_a_m_e This option may be used to select the project of interest. When no --PPrroojjeecctt option is specified, the _A_E_G_I_S___P_R_O_J_E_C_T envi- ronment variable is consulted. If that does not exist, the user's _$_H_O_M_E_/_._a_e_g_i_s_r_c file is examined for a default project field (see _a_e_u_c_o_n_f(5) for more information). If that does not exist, when the user is only working on changes within a single project, the project name defaults to that project. Otherwise, it is an error. --TTEERRssee This option may be used to cause listings to produce the bare minimum of information. It is usually useful for shell scripts. --TTRRuunnkk This option may be used to specify the project trunk for the origin file, rather than the baseline. (See also --BBRRaanncchh option, the -trunk option is the same as the "-branch -" option.) --UUNNFFoorrmmaatttteedd This option may be used with most listings to specify that the column formatting is not to be performed. This is useful for shell scripts. --PPaaggee--HHeeaaddeerr This option requests that page headings be present in listings and reports. This is the default. --NNoo--PPaaggee--HHeeaaddeerr This option requests that page headings be omitted from list- ings and reports. --VVeerrbboossee This option may be used to cause aereport to produce more out- put. By default aereport only produces output on errors. When used with the --LLiisstt option this option causes column headings to be added. See also _a_e_g_i_s(1) for options common to all aegis commands. All options may be abbreviated; the abbreviation is documented as the upper case letters, all lower case letters and underscores (_) are optional. You must use consecutive sequences of optional letters. All options are case insensitive, you may type them in upper case or lower case or a combination of both, case is not important. For example: the arguments "-project, "-PROJ" and "-p" are all inter- preted to mean the --PPrroojjeecctt option. The argument "-prj" will not be understood, because consecutive optional characters were not supplied. Options and other command line arguments may be mixed arbitrarily on the command line, after the function selectors. The GNU long option names are understood. Since all option names for _a_e_r_e_p_o_r_t are long, this means ignoring the extra leading '-'. The "----_o_p_t_i_o_n==_v_a_l_u_e" convention is also understood. RREECCOOMMMMEENNDDEEDD AALLIIAASS The recommended alias for this command is csh% alias aer 'aereport \!* -v' sh$ aer(){aereport "$@" -v} SSEEEE AALLSSOO _a_e_l(1) list (possibly) interesting things _a_e_r(5) report script language definition EEXXIITT SSTTAATTUUSS The _a_e_r_e_p_o_r_t command will exit with a status of 1 on any error. The _a_e_r_e_p_o_r_t command will only exit with a status of 0 if there are no errors. EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS See _a_e_g_i_s(1) for a list of environment variables which may affect this command. See _a_e_p_c_o_n_f(5) for the project configuration file's _p_r_o_j_e_c_t___- _s_p_e_c_i_f_i_c field for how to set environment variables for all commands executed by Aegis. CCOOPPYYRRIIGGHHTT aereport version 4.D021 Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Peter Miller The aereport program comes with ABSOLUTELY NO WARRANTY; for details use the '_a_e_r_e_p_o_r_t _-_V_E_R_S_i_o_n _L_i_c_e_n_s_e' command. This is free software and you are welcome to redistribute it under certain conditions; for details use the '_a_e_r_e_p_o_r_t _-_V_E_R_S_i_o_n _L_i_c_e_n_s_e' command. AAUUTTHHOORR Peter Miller E-Mail: millerp@canb.auug.org.au /\/\* WWW: http://www.canb.auug.org.au/~millerp/ Reference Manual Aegis aereport -RePorT(1)