help

package
Version: v0.0.0-...-6d6101f Latest Latest
Warning

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

Go to latest
Published: Feb 17, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var HelpMessages = map[string]Help{
	"help": Help{
		Name:      "/help",
		ShortDesc: "command help",
		Synopsis: map[string]string{
			"":          "show this help",
			"<command>": "show help for <command> (without the `/`)",
		},
		Overview:    "Give help on an internal command",
		Description: "Find out more information on topics in Stimmtausch by using the /help command. For instance, to learn about the `/log` command, type `/help log`.\n\n    Available topics:\n\n    {HELPTOPICS}",
	},

	"log": Help{
		Name:      "/log",
		ShortDesc: "connection logging",
		Synopsis: map[string]string{
			"":             "show this help",
			"--help":       "show this help",
			"--list":       "list open log files",
			"<file>":       "start logging the current world to the specified file",
			"--off <file>": "stop logging to the specified file",
		},
		Overview:    "Command to control logging output from worlds.",
		Description: "Logging in Stimmtausch is controlled through the /log command. Invoked with a file name, it starts logging the current world's output to the specified file (absolute, or relative to the directory in which Stimmtausch was started). You can turn logging off at any time by calling `/log --off <file>`. To list what logs are open, you can call `/log --list`",
	},

	"fg": Help{
		Name:      "/fg",
		ShortDesc: "bring world to the foreground",
		Synopsis: map[string]string{
			"":        "rotate to the next active world to the right (same as `/]`)",
			">":       "rotate to the next world to the right",
			"<":       "rotate to the next world to the left",
			"]":       "rotate to the next active world to the right",
			"[":       "rotate to the next active world to the left",
			"<world>": "switch to the named world",
		},
		Overview:    "Command to control moving between worlds.",
		Description: "Moving between worlds in Stimmtausch is accomplished with the /fg command. You can rotate between worlds by using the special world names > and <, otherwise you can specifi which world you would like to bring to the foreground.",
		SeeAlso:     "`/>` (same as `/fg >`), `/<` (same as `/fg <`), `/]` (same as `/fg ]`), `/[` (same as `/fg [`)",
	},

	"connect": Help{
		Name:      "/connect",
		ShortDesc: "connect to worlds",
		Synopsis: map[string]string{
			"<named world>": "connect to the named world",
		},
		Overview:    "Command to connect to worlds.",
		Description: "Connecting to worlds in Stimmtausch is accomplished with the /connect command. You can connect to worlds named in your configuration files.",
		SeeAlso:     "`/c` (shortcut for `/connect`), `/disconnect`, `/fg`",
	},

	"disconnect": Help{
		Name:      "/disconnect",
		ShortDesc: "disconnect from worlds",
		Synopsis: map[string]string{
			"[-r]":         "disconnect from the current world",
			"[-r] <world>": "disconnect from the world specified",
		},
		Overview:    "Command to disconnect from worlds.",
		Description: "Disconnecting from worlds in Stimmtausch is accomplished with the /disconnect command. It accepts a world name. Passing `-r` will remove the world from the world list as well.",
		SeeAlso:     "`/dc` (shortcut for `/disconnect`), `/connect`, `/remove`",
	},

	"remove": Help{
		Name:      "/remove",
		ShortDesc: "remove the world from the UI",
		Synopsis: map[string]string{
			"<world>": "removes the current world from the UI's world list",
		},
		Overview:    "Command to remove the current world from the UI's world list",
		Description: "This command will remove the current world from the world list in the UI. It will do so whether or not the world is currently connected. There is currently no way to add that world back in, so use with care!",
		SeeAlso:     "`/disconnect -r`",
	},

	"quit": Help{
		Name:      "/quit",
		ShortDesc: "quit Stimmtausch",
		Synopsis: map[string]string{
			"": "disconnect from all worlds and quit Stimmtausch",
		},
		Overview:    "Command to quit Stimmtausch.",
		Description: "Quitting Stimmtausch is accomplished to the /quit command.",
	},

	"syslog": Help{
		Name:      "/syslog",
		ShortDesc: "log to the system log",
		Synopsis: map[string]string{
			"<level> <message>": "You may log arbitrary information to the system log via the /syslog command. Why? We're sure you have your reasons! The log level is the first argument, and may be one of 'TRACE', 'DEBUG', 'INFO', 'WARNING', 'ERROR', or 'CRITICAL'.",
		},
	},
}

Functions

func RenderText

func RenderText(h Help) string

Types

type Help

type Help struct {
	Name        string
	ShortDesc   string
	Synopsis    map[string]string
	Overview    string
	Description string
	SeeAlso     string
}

Jump to

Keyboard shortcuts

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