stimmtausch: github.com/makyo/stimmtausch/help Index | Files

package help

import "github.com/makyo/stimmtausch/help"

Index

Package Files

builtins.go help.go text.go

Variables

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: "" /* 186 byte string literal not displayed */,
    },

    "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: "" /* 356 byte string literal not displayed */,
    },

    "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: "" /* 229 byte string literal not displayed */,
        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: "" /* 141 byte string literal not displayed */,
        SeeAlso:     "`/disconnect`, `/fg`",
    },

    "disconnect": Help{
        Name:      "/disconnect",
        ShortDesc: "disconnect from worlds",
        Synopsis: map[string]string{
            "<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.",
        SeeAlso:     "`/connect`",
    },

    "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>": "" /* 233 byte string literal not displayed */,
        },
    },
}

func RenderText Uses

func RenderText(h Help) string

type Help Uses

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

Package help imports 6 packages (graph) and is imported by 1 packages. Updated 2020-08-14. Refresh now. Tools for package owners.