Additional pod docs

This commit is contained in:
Duncan Ferguson 2014-06-29 12:49:37 +01:00
parent 7efebc30b9
commit 858112c072
4 changed files with 89 additions and 40 deletions

View file

@ -2004,6 +2004,8 @@ the code until this time.
=item add_host_by_name
=item add_option
=item build_hosts_menu
=item capture_map_events
@ -2012,81 +2014,85 @@ the code until this time.
=item change_main_window_title
=item close_inactive_sessions
=item close_inactive_sessions
=item config
=item config
=item helper
=item helper
=item cluster
=item create_menubar
=item create_menubar
=item create_windows
=item create_windows
=item dump_config
=item dump_config
=item list_tags
=item getopts
=item evaluate_commands
=item list_tags
=item exit_prog
=item evaluate_commands
=item get_clusters
=item exit_prog
=item get_font_size
=item get_clusters
=item get_keycode_state
=item get_font_size
=item key_event
=item get_keycode_state
=item load_config_defaults
=item key_event
=item load_configfile
=item load_config_defaults
=item load_keyboard_map
=item load_configfile
=item logmsg
=item load_keyboard_map
=item new
=item logmsg
=item open_client_windows
=item new
=item parse_config_file
=item open_client_windows
=item pick_color
=item options
=item populate_send_menu
=item parse_config_file
=item populate_send_menu_entries_from_xml
=item pick_color
=item populate_send_menu
=item populate_send_menu_entries_from_xml
=item remove_repeated_servers
=item resolve_names
=item resolve_names
=item retile_hosts
=item retile_hosts
=item run
=item run
=item send_resizemove
=item send_resizemove
=item send_text
=item send_text
=item send_text_to_all_servers
=item send_text_to_all_servers
=item setup_repeat
=item setup_repeat
=item show_console
=item show_console
=item show_history
=item show_history
=item terminate_host
=item terminate_host
=item toggle_active_state
=item toggle_active_state
=item update_display_text
=item update_display_text
=item write_default_user_config
=item write_default_user_config
=back

View file

@ -340,6 +340,11 @@ a wrapper to maketext in Locale::Maketext
Output text on STDOUT.
=item $ovj->parent;
Reutrned the object that is the parent of this one, if it was set when the
object was created
=item $obj->exit;
Stub to allow program to exit neatly from wherever in the code

View file

@ -1073,13 +1073,43 @@ Object representing application configuration
=over 4
=item $host=ClusterSSH::Helper->new ({ })
=item $obj=ClusterSSH::Getopts->new ({ })
Create a new helper object.
Create a new object.
=item $host=ClusterSSH::Helper->script ({ })
=item $obj=ClusterSSH::Getopts->add_option ({ })
Return the helper script
Add extra options into the allowed set for parsing from the command line
=item $obj=ClusterSSH::Getopts->add_common_options ({ })
Add common options used by most calling scripts into the allowed set for
parsing from the command line
=item $obj=ClusterSSH::Getopts->add_common_session_options ({ })
Add common session options used by most calling scripts into the allowed
set for parsing from the command line
=item $obj=ClusterSSH::Getopts->add_common_ssh_options ({ })
Add common ssh options used by most calling scripts into the allowed
set for parsing from the command line
=item $obj->getopts
Function to call after all options have been set up; creates methods to
call for each option on the object, such as $obj->action, or $obj->username
=item output(@)
Simple helper func to print out pod lines with double returns
=item help
=item usage
Functions to output help and usage instructions
=back

View file

@ -375,6 +375,10 @@ Create a new host object. 'hostname' is a required arg, 'username' and
=item $host->get_master
=item $host->get_geometry
=item $host->get_type
Return specific details about the host
=item $host->set_username
@ -383,6 +387,10 @@ Return specific details about the host
=item $host->set_master
=item $host->set_geometry
=item $host->set_type
Set specific details about the host after its been created.
=item get_realname