cli

Documentation

Overview

Package cli implements the socat command-line interface.

Index

• func Run(args []string, signalExit func(int)) int
• type Config
  • func ParseArgs(args []string) (*Config, error)

Functions

func Run

func Run(args []string, signalExit func(int)) int

Run runs socat with the given args (excluding program name). signalExit is owned by cmd/socat so tests can exercise signal handling without terminating the test process.

Types

type Config

type Config struct {
	Help          int // 0 none, 1 -h, 2 -hh, 3 -hhh
	Version       bool
	LogLevel      logx.Level
	LogFile       string
	Progname      string
	Micros        bool
	Hostname      bool
	Verbose       bool
	Hex           bool
	BlockSize     int
	Linger        time.Duration
	Idle          time.Duration // <0 infinite, 0 zero, >0 timeout
	IdleSet       bool
	LeftToRight   bool // -u
	RightToLeft   bool // -U
	IP4           bool
	IP6           bool
	IPAny         bool
	Statistics    bool
	Experimental  bool
	LockFile      string
	LockWait      string
	RawLeft       string // -r
	RawRight      string // -R
	SignalLogMask uint64 // -S: signals whose termination is logged
	Addresses     []string
}

Config holds parsed global options.

func ParseArgs

func ParseArgs(args []string) (*Config, error)

ParseArgs parses os.Args-style arguments (without program name).