---
name: "App::ClusterSSH::Getopt"
section: "3pm"
platform: "linux"
package: "clusterssh"
version: "4.18-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/App::ClusterSSH::Getopt"
---

# App::ClusterSSH::Getopt(3pm)

## SYNOPSIS

## DESCRIPTION

Object representing application configuration

## METHODS

- $obj=ClusterSSH::Getopts-\>new ({ })

  Create a new object.

- $obj=ClusterSSH::Getopts-\>add\_option ({ })

  Add extra options into the allowed set for parsing from the command line

- $obj=ClusterSSH::Getopts-\>add\_common\_options ({ })

  Add common options used by most calling scripts into the allowed set for parsing from the command line

- $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

- $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

- $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

- output(@)

  Simple helper func to print out pod lines with double returns

- help

  - usage

  Functions to output help and usage instructions