%% Automatically generated. Do not edit.
{srcfile, "ref_man"}.
{appname, "common_test"}.
{appvsn, "1.4.5"}.
{app, "run_test"}.
{appsummary, "Shell script used for starting Common Test from the Unix command line. "}.
{app, "common_test_app"}.
{appsummary, "A framework for automated testing of arbitrary target nodes"}.
{name, "Module:all()"}.
{fsummary, "Returns the list of all test cases in the module."}.
{name, "Module:groups()"}.
{fsummary, "Returns a list of test case group definitions."}.
{name, "Module:suite()"}.
{fsummary, "Test suite info function (providing default data for the suite)."}.
{name, "Module:init_per_suite(Config)"}.
{fsummary, "Test suite initialization."}.
{name, "Module:end_per_suite(Config)"}.
{fsummary, "Test suite finalization. "}.
{name, "Module:init_per_group(GroupName,"}.
{fsummary, "Test case group initialization."}.
{name, "Module:end_per_group(GroupName,"}.
{fsummary, "Test case group finalization."}.
{name, "Module:init_per_testcase(TestCase,"}.
{fsummary, "Test case initialization."}.
{name, "Module:end_per_testcase(TestCase,"}.
{fsummary, "Test case finalization."}.
{name, "Module:testcase()"}.
{fsummary, "Test case info function. "}.
{name, "Module:testcase(Config)"}.
{fsummary, "A test case"}.
{module, "ct"}.
{modulesummary, "Main user interface for the Common Test framework."}.
{name, "abort_current_testcase/1"}.
{fsummary, "When calling this function, the currently executing test case will be aborted."}.
{name, "comment/1"}.
{fsummary, "Print the given Comment in the comment field of  the table on the test suite result page."}.
{name, "decrypt_config_file/2"}.
{fsummary, "This function decrypts EncryptFileName, previously generated with encrypt_config_file/2/3."}.
{name, "decrypt_config_file/3"}.
{fsummary, "This function decrypts EncryptFileName, previously generated with encrypt_config_file/2/3."}.
{name, "encrypt_config_file/2"}.
{fsummary, "This function encrypts the source config file with DES3 and saves the result in file EncryptFileName."}.
{name, "encrypt_config_file/3"}.
{fsummary, "This function encrypts the source config file with DES3 and saves the result in the target file EncryptFileName."}.
{name, "fail/1"}.
{fsummary, "Terminate a test case with the given error Reason."}.
{name, "get_config/1"}.
{fsummary, "Equivalent to get_config(Required, undefined, []). "}.
{name, "get_config/2"}.
{fsummary, "Equivalent to get_config(Required, Default, []). "}.
{name, "get_config/3"}.
{fsummary, "Read config data values."}.
{name, "get_status/0"}.
{fsummary, "Returns status of ongoing tests."}.
{name, "get_target_name/1"}.
{fsummary, "Return the name of the target that the given connection belongs to."}.
{name, "install/1"}.
{fsummary, "Install config files and event handlers."}.
{name, "listenv/1"}.
{fsummary, "Performs the listenv command on the given telnet connection and returns the result as a list of Key-Value pairs."}.
{name, "log/1"}.
{fsummary, "Equivalent to log(default, Format, []). "}.
{name, "log/2"}.
{fsummary, "Equivalent to log(Category, Format, Args). "}.
{name, "log/3"}.
{fsummary, "Printout from a testcase to the log."}.
{name, "pal/1"}.
{fsummary, "Equivalent to pal(default, Format, []). "}.
{name, "pal/2"}.
{fsummary, "Equivalent to pal(Category, Format, Args). "}.
{name, "pal/3"}.
{fsummary, "Print and log from a testcase."}.
{name, "parse_table/1"}.
{fsummary, "Parse the printout from an SQL table and return a list of tuples."}.
{name, "print/1"}.
{fsummary, "Equivalent to print(default, Format, []). "}.
{name, "print/2"}.
{fsummary, "Equivalent to print(Category, Format, Args). "}.
{name, "print/3"}.
{fsummary, "Printout from a testcase to the console."}.
{name, "require/1"}.
{fsummary, "Check if the required configuration is available."}.
{name, "require/2"}.
{fsummary, "Check if the required configuration is available, and give it  a name."}.
{name, "run/1"}.
{fsummary, "Run all testcases in all suites in the given directories."}.
{name, "run/2"}.
{fsummary, "Run all testcases in the given suite."}.
{name, "run/3"}.
{fsummary, "Run the given testcase(s)."}.
{name, "run_test/1"}.
{fsummary, "Run tests as specified by the combination of options in Opts."}.
{name, "run_testspec/1"}.
{fsummary, "Run test specified by TestSpec."}.
{name, "start_interactive/0"}.
{fsummary, "Start CT in interactive mode."}.
{name, "step/3"}.
{fsummary, "Step through a test case with the debugger."}.
{name, "step/4"}.
{fsummary, "Step through a test case with the debugger."}.
{name, "stop_interactive/0"}.
{fsummary, "Exit the interactive mode."}.
{name, "testcases/2"}.
{fsummary, "Returns all testcases in the specified suite."}.
{name, "userdata/2"}.
{fsummary, "Returns any data specified with the tag userdata in the list of tuples returned from Suite:suite/0."}.
{name, "userdata/3"}.
{fsummary, "Returns any data specified with the tag userdata in the list of tuples returned from Suite:Case/0."}.
{module, "ct_master"}.
{modulesummary, "Distributed test execution control for Common Test."}.
{name, "abort/0"}.
{fsummary, "Stops all running tests."}.
{name, "abort/1"}.
{fsummary, "Stops tests on specified nodes."}.
{name, "progress/0"}.
{fsummary, "Returns test progress."}.
{name, "run/1"}.
{fsummary, "Equivalent to run(TestSpecs, false, [], []). "}.
{name, "run/3"}.
{fsummary, "Equivalent to run(TestSpecs, false, InclNodes, ExclNodes). "}.
{name, "run/4"}.
{fsummary, "Tests are spawned on the nodes as specified in TestSpecs."}.
{name, "run_on_node/2"}.
{fsummary, "Equivalent to run_on_node(TestSpecs, false, Node). "}.
{name, "run_on_node/3"}.
{fsummary, "Tests are spawned on Node according to TestSpecs."}.
{name, "run_test/2"}.
{fsummary, "Tests are spawned on Node using ct:run_test/1."}.
{module, "ct_cover"}.
{modulesummary, "Common Test Framework code coverage support module."}.
{name, "add_nodes/1"}.
{fsummary, " "}.
{name, "remove_nodes/1"}.
{fsummary, "Remove nodes from current cover test."}.
{module, "ct_ftp"}.
{modulesummary, "FTP client module (based on the FTP support of the INETS application)."}.
{name, "cd/2"}.
{fsummary, "Change directory on remote host."}.
{name, "close/1"}.
{fsummary, "Close the FTP connection."}.
{name, "delete/2"}.
{fsummary, "Delete a file on remote host."}.
{name, "get/3"}.
{fsummary, "Open a ftp connection and fetch a file from the remote host."}.
{name, "ls/2"}.
{fsummary, "List the directory Dir."}.
{name, "open/1"}.
{fsummary, "Open an FTP connection to the specified node."}.
{name, "put/3"}.
{fsummary, "Open a ftp connection and send a file to the remote host."}.
{name, "recv/2"}.
{fsummary, "Fetch a file over FTP."}.
{name, "recv/3"}.
{fsummary, "Fetch a file over FTP."}.
{name, "send/2"}.
{fsummary, "Send a file over FTP."}.
{name, "send/3"}.
{fsummary, "Send a file over FTP."}.
{name, "type/2"}.
{fsummary, "Change file transfer type."}.
{module, "ct_ssh"}.
{modulesummary, "SSH/SFTP client module."}.
{name, "apread/4"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "apread/5"}.
{fsummary, " "}.
{name, "apwrite/4"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "apwrite/5"}.
{fsummary, " "}.
{name, "aread/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "aread/4"}.
{fsummary, " "}.
{name, "awrite/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "awrite/4"}.
{fsummary, " "}.
{name, "close/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "close/3"}.
{fsummary, " "}.
{name, "connect/1"}.
{fsummary, "Equivalent to connect(KeyOrName, host, []). "}.
{name, "connect/2"}.
{fsummary, "Equivalent to connect(KeyOrName, ConnType, []). "}.
{name, "connect/3"}.
{fsummary, "Open an SSH or SFTP connection using the information associated with KeyOrName."}.
{name, "del_dir/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "del_dir/3"}.
{fsummary, " "}.
{name, "delete/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "delete/3"}.
{fsummary, " "}.
{name, "disconnect/1"}.
{fsummary, "Close an SSH/SFTP connection."}.
{name, "exec/2"}.
{fsummary, "Equivalent to exec(SSH, Command, DefaultTimeout). "}.
{name, "exec/3"}.
{fsummary, "Requests server to perform Command."}.
{name, "exec/4"}.
{fsummary, "Requests server to perform Command."}.
{name, "get_file_info/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "get_file_info/3"}.
{fsummary, " "}.
{name, "list_dir/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "list_dir/3"}.
{fsummary, " "}.
{name, "make_dir/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "make_dir/3"}.
{fsummary, " "}.
{name, "make_symlink/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "make_symlink/4"}.
{fsummary, " "}.
{name, "open/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "open/4"}.
{fsummary, " "}.
{name, "opendir/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "opendir/3"}.
{fsummary, " "}.
{name, "position/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "position/4"}.
{fsummary, " "}.
{name, "pread/4"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "pread/5"}.
{fsummary, " "}.
{name, "pwrite/4"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "pwrite/5"}.
{fsummary, " "}.
{name, "read/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "read/4"}.
{fsummary, " "}.
{name, "read_file/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "read_file/3"}.
{fsummary, " "}.
{name, "read_file_info/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "read_file_info/3"}.
{fsummary, " "}.
{name, "read_link/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "read_link/3"}.
{fsummary, " "}.
{name, "read_link_info/2"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "read_link_info/3"}.
{fsummary, " "}.
{name, "receive_response/2"}.
{fsummary, "Equivalent to receive_response(SSH, ChannelId, close). "}.
{name, "receive_response/3"}.
{fsummary, "Equivalent to receive_response(SSH, ChannelId, End, DefaultTimeout). "}.
{name, "receive_response/4"}.
{fsummary, "Receives expected data from server on the specified  session channel."}.
{name, "rename/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "rename/4"}.
{fsummary, " "}.
{name, "send/3"}.
{fsummary, "Equivalent to send(SSH, ChannelId, 0, Data, DefaultTimeout). "}.
{name, "send/4"}.
{fsummary, "Equivalent to send(SSH, ChannelId, 0, Data, Timeout). "}.
{name, "send/5"}.
{fsummary, "Send data to server on specified session channel."}.
{name, "send_and_receive/3"}.
{fsummary, "Equivalent to send_and_receive(SSH, ChannelId, Data, close). "}.
{name, "send_and_receive/4"}.
{fsummary, "Equivalent to send_and_receive(SSH, ChannelId, 0, Data, End,                 DefaultTimeout). "}.
{name, "send_and_receive/5"}.
{fsummary, "Equivalent to send_and_receive(SSH, ChannelId, 0, Data, End, Timeout). "}.
{name, "send_and_receive/6"}.
{fsummary, "Send data to server on specified session channel and wait  to receive the server response."}.
{name, "session_close/2"}.
{fsummary, "Closes an SSH session channel."}.
{name, "session_open/1"}.
{fsummary, "Equivalent to session_open(SSH, DefaultTimeout). "}.
{name, "session_open/2"}.
{fsummary, "Opens a channel for an SSH session."}.
{name, "sftp_connect/1"}.
{fsummary, "Starts an SFTP session on an already existing SSH connection."}.
{name, "subsystem/3"}.
{fsummary, "Equivalent to subsystem(SSH, ChannelId, Subsystem, DefaultTimeout). "}.
{name, "subsystem/4"}.
{fsummary, "Sends a request to execute a predefined subsystem."}.
{name, "write/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "write/4"}.
{fsummary, " "}.
{name, "write_file/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "write_file/4"}.
{fsummary, " "}.
{name, "write_file_info/3"}.
{fsummary, "For info and other types, see ssh_sftp(3)."}.
{name, "write_file_info/4"}.
{fsummary, " "}.
{module, "ct_rpc"}.
{modulesummary, "Common Test specific layer on Erlang/OTP rpc."}.
{name, "app_node/2"}.
{fsummary, "From a set of candidate nodes determines which of them is running the application App."}.
{name, "app_node/3"}.
{fsummary, "Same as app_node/2 only the FailOnBadRPC argument will determine if the search for a candidate node should stop or not if badrpc is received at some point."}.
{name, "app_node/4"}.
{fsummary, "Same as app_node/2 only the FailOnBadRPC argument will determine if the search for a candidate node should stop or not if badrpc is received at some point."}.
{name, "call/4"}.
{fsummary, "Same as call(Node, Module, Function, Args, infinity)."}.
{name, "call/5"}.
{fsummary, "Evaluates apply(Module, Function, Args) on the node Node."}.
{name, "call/6"}.
{fsummary, "Evaluates apply(Module, Function, Args) on the node Node."}.
{name, "cast/4"}.
{fsummary, "Evaluates apply(Module, Function, Args) on the node Node."}.
{name, "cast/5"}.
{fsummary, "Evaluates apply(Module, Function, Args) on the node Node."}.
{module, "ct_snmp"}.
{modulesummary, "Common Test user interface module for the OTP snmp application."}.
{name, "get_next_values/3"}.
{fsummary, "Issues a synchronous snmp get next request."}.
{name, "get_values/3"}.
{fsummary, "Issues a synchronous snmp get request."}.
{name, "load_mibs/1"}.
{fsummary, "Load the mibs into the agent 'snmp_master_agent'."}.
{name, "register_agents/2"}.
{fsummary, "Explicitly instruct the manager to handle this agent."}.
{name, "register_users/2"}.
{fsummary, "Register the manager entity (=user) responsible for specific agent(s)."}.
{name, "register_usm_users/2"}.
{fsummary, "Explicitly instruct the manager to handle this USM user."}.
{name, "set_info/1"}.
{fsummary, "Returns a list of all successful set requests performed in the test case in reverse order."}.
{name, "set_values/4"}.
{fsummary, "Issues a synchronous snmp set request."}.
{name, "start/2"}.
{fsummary, "Equivalent to start(Config, MgrAgentConfName, undefined). "}.
{name, "start/3"}.
{fsummary, "Starts an snmp manager and/or agent."}.
{name, "stop/1"}.
{fsummary, "Stops the snmp manager and/or agent removes all files created."}.
{name, "unregister_agents/1"}.
{fsummary, " Removes information added when calling register_agents/2."}.
{name, "unregister_users/1"}.
{fsummary, "Removes information added when calling register_users/2."}.
{name, "update_usm_users/2"}.
{fsummary, " Alters information added when calling register_usm_users/2."}.
{module, "ct_telnet"}.
{modulesummary, "Common Test specific layer on top of telnet client ct_telnet_client.erl."}.
{name, "close/1"}.
{fsummary, "Close the telnet connection and stop the process managing it."}.
{name, "cmd/2"}.
{fsummary, "Equivalent to cmd(Connection, Cmd, DefaultTimeout). "}.
{name, "cmd/3"}.
{fsummary, " "}.
{name, "cmdf/3"}.
{fsummary, "Equivalent to cmdf(Connection, CmdFormat, Args, DefaultTimeout). "}.
{name, "cmdf/4"}.
{fsummary, " "}.
{name, "cont_log/2"}.
{fsummary, " "}.
{name, "end_log/0"}.
{fsummary, " "}.
{name, "expect/2"}.
{fsummary, "Equivalent to expect(Connections, Patterns, []). "}.
{name, "expect/3"}.
{fsummary, "Get data from telnet and wait for the expected pattern."}.
{name, "get_data/1"}.
{fsummary, "Get all data which has been received by the telnet client since last command was sent."}.
{name, "open/1"}.
{fsummary, "Equivalent to open(Name, telnet). "}.
{name, "open/2"}.
{fsummary, "Open a telnet connection to the specified target host."}.
{name, "open/3"}.
{fsummary, "Equivalent to open(KeyOrName, ConnType, TargetMod, []). "}.
{name, "open/4"}.
{fsummary, "Open a telnet connection to the specified target host."}.
{name, "send/2"}.
{fsummary, "Send a telnet command and return immediately."}.
{name, "sendf/3"}.
{fsummary, "Send a telnet command and return immediately (uses a format string and a list of arguments to build the command)."}.
{module, "unix_telnet"}.
{modulesummary, "Callback module for ct_telnet for talking telnet  to a unix host."}.
