configuration

package
v1.3.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 7, 2025 License: BSD-3-Clause Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AspectRatio added in v1.0.2

type AspectRatio struct {
	Width  int
	Height int
}

func (AspectRatio) String added in v1.0.5

func (a AspectRatio) String() string

type AspectRatioData added in v1.0.5

type AspectRatioData struct {
	ValueChanged chan AspectRatio
	Width        int
	Height       int
}

type AspectRatios added in v1.0.5

type AspectRatios struct {
	Min     AspectRatioData
	Max     AspectRatioData
	Disable bool
}

type Config

type Config struct {
	Version     bool   `ff:"short: v, long: version,                      usage: 'show version'"`
	Address     string `ff:"short: h, long: host,     default: 127.0.0.1, usage: 'address that present will listen on'"`
	Port        int    `ff:"short: p, long: port,     default: 8080,      usage: 'port that present will listen on'"`
	Tag         bool   `ff:"short: t, long: tag,                          usage: 'show tag'"`
	Compress    string `ff:"short: c, long: compress,                     usage: 'compress current folder'"`
	File        string `ff:"short: f, long: file,                         usage: 'file to open (.tar.gz format)'"`
	GIT         string `ff:"short: g, long: git,                          usage: 'git repository URL'"`
	GITKey      string `ff:"          long: key,                          usage: 'ssh key used for git clone auth'"`
	Dir         string `ff:"short: d, long: dir,                          usage: 'directory to open'"`
	Help        bool   `ff:"          long: help,                         usage: 'help'"`
	AspectRatio AspectRatios

	Security Security
	Controls Controls
	Update   Update
}

func Get

func Get() Config

func (*Config) CheckPasswords

func (c *Config) CheckPasswords()

func (*Config) CompressPresentation

func (c *Config) CompressPresentation()

func (*Config) DecompressPresentation

func (c *Config) DecompressPresentation()

func (*Config) Git

func (c *Config) Git()

type Controls

type Controls struct {
	Menu          string `ff:"long: menu,              usage: 'keys that opens menu'"`
	Options       string `ff:"long: options,           usage: 'keys that opens options'"`
	NextPage      string `ff:"long: next-page,         usage: 'keys that go to next page'"`
	PreviousPage  string `ff:"long: previous-page,     usage: 'keys that go to previous page'"`
	TerminalCast  string `ff:"long: terminal-cast,     usage: 'keys that run commands'"`
	TerminalClose string `ff:"long: terminal-close,    usage: 'keys that closes terminal'"`
}

type Security

type Security struct {
	AdminPwd        string `ff:"long: admin-pwd,         usage: 'admin password'"`
	UserPwd         string `ff:"long: user-pwd,          usage: 'user password'"`
	AllowAnyUser    bool   `ff:"long: any-user,          usage: 'allow any user to login without password'"`
	AdminPwdDisable bool   `ff:"long: admin-pwd-disable, usage: 'disable admin password'"`
}

type Update

type Update struct {
	Latest bool `ff:"long: latest, usage: 'update to latest version if go is installed'"`
}

func (*Update) UpdateToLatest

func (u *Update) UpdateToLatest() bool

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL