About

This module holds the class that manages Telnet Options as well as an instance of the class

Base

api

usage: #bp.options.api [-h] [api]

list functions in the api

positional arguments:
  api         api to get details of

optional arguments:
  -h, --help  show help (default: False)

help

usage: #bp.options.help [-a] [-c] [-h]

show help info for this plugin

optional arguments:
  -a, --api       show functions this plugin has in the api (default: False)
  -c, --commands  show commands in this plugin (default: False)
  -h, --help      show help (default: False)

inspect

usage: #bp.options.inspect [-m METHOD] [-o OBJECT] [-s] [-h]

inspect a plugin

optional arguments:
  -m METHOD, --method METHOD
                        get code for a method
  -o OBJECT, --object OBJECT
                        show an object of the plugin, can be method or
                        variable
  -s, --simple          show a simple output (default: False)
  -h, --help            show help (default: False)

reset

usage: #bp.options.reset [-h]

reset the plugin

optional arguments:
  -h, --help  show help (default: False)

save

usage: #bp.options.save [-h]

save the plugin state

optional arguments:
  -h, --help  show help (default: False)

set

usage: #bp.options.set [-h] [name] [value]

change a setting in the plugin

if there are no arguments or 'list' is the first argument then
it will list the settings for the plugin

positional arguments:
  name        the setting name (default: list)
  value       the new value of the setting

optional arguments:
  -h, --help  show help (default: False)

stats

usage: #bp.options.stats [-h]

show plugin stats

optional arguments:
  -h, --help  show help (default: False)

addclientoption

options.addclientoption(optionname, clientoption)
  add a client option
    clientoption  = client option to add, must be of
                                        class BaseTelnetOption


original defined in plugins/core/options.py

prepareclient

options.prepareclient(client)

    add an option to a client


original defined in plugins/core/options.py

addserveroption

options.addserveroption(optionname, serveroption)
  add a server option
    serveroption  = server option to add, must be of
                                        class BaseTelnetOption


original defined in plugins/core/options.py

prepareserver

options.prepareserver(server)

    add an option to a server


original defined in plugins/core/options.py

resetoptions

options.resetoptions(server, onclose=False)

    reset options


original defined in plugins/core/options.py