(zettel (meta (back "00001004010000 00001004100000 00001018000000") (backward "00001004010000 00001004100000 00001018000000") (box-number "1") (created "20210510141304") (forward "00001004059700") (modified "20220823194553") (published "20220823194553") (role "manual") (syntax "zmk") (tags "#configuration #manual #zettelstore") (title "List of supported commands of the administrator console")) (rights 4) (encoding "") (content "; [!bye|''bye'']\n: Closes the connection to the administrator console.\n; [!config|''config SERVICE'']\n: Displays all valid configuration keys for the given service.\n\n  If a key ends with the hyphen-minus character (\"\"''-''\"\", U+002D), the key denotes a list value.\n  Keys of list elements are specified by appending a number greater than zero to the key.\n; [!crlf|''crlf'']\n: Toggles CRLF mode for console output.\n  Changes end of line sequences between Windows mode (==\\\\r\\\\n==) and non-Windows mode (==\\\\n==, initial value).\n  Often used on Windows telnet clients that otherwise scramble the output of commands.\n; [!dump-index|''dump-index'']\n: Displays the content of the internal search index.\n; [!dump-recover|''dump-recover RECOVER'']\n: Displays data about the last given recovered internal activity.\n\n  The value for ''RECOVER'' can be obtained via the command ``stat core``, which lists all overview data about all recoveries.\n; [!echo|''echo'']\n: Toggles the echo mode, where each command is printed before execution.\n; [!end-profile|''end-profile'']\n: Stops profiling the application.\n; [!env|''env'']\n: Display environment values.\n; [!help|''help'']\n: Displays a list of all available commands.\n; [!get-config|''get-config'']\n: Displays current configuration data.\n\n  ``get-config`` shows all current configuration data.\n\n  ``get-config SERVICE`` shows only the current configuration data of the given service.\n\n  ``get-config SERVICE KEY`` shows the current configuration data for the given service and key.\n; [!header|''header'']\n: Toggles the header mode, where each table is show with a header nor not.\n; [!log-level|''log-level'']\n: Displays or sets the [[logging level|00001004059700]] for the kernel or a service.\n\n  ``log-level`` shows all known log level.\n\n  ``log-level NAME`` shows log level for the given service or for the kernel.\n\n  ``log-level NAME VALUE`` sets the log level for the given service or for the kernel.\n  ''VALUE'' is either the name of the log level or its numerical value.\n; [!metrics|''metrics'']\n: Displays some values that reflect the inner workings of Zettelstore.\n  See [[here|https://golang.org/pkg/runtime/metrics/]] for a technical description of these values.\n; [!next-config|''next-config'']\n: Displays next configuration data.\n  It will be the current configuration, if the corresponding services is restarted.\n\n  ``next-config`` shows all next configuration data.\n\n  ``next-config SERVICE`` shows only the next configuration data of the given service.\n\n  ``next-config SERVICE KEY`` shows the next configuration data for the given service and key.\n; [!profile|''profile [PROFILE] [FILE]'']\n: Starts to profile the software with the profile PROFILE and writes profiling data to file FILE.\n  If PROFILE is not given, a value ''CPU'' is assumed, which specifies to profile CPU usage.\n  If FILE is not given, a value ''PROFILE.prof'' will be used.\n\n  Other values for ''PROFILE'' are: ''goroutine'', ''heap'', ''allocs'', ''threadcreate'', ''block'', and ''mutex''.\n  In the future, more values may be appropriate.\n  See the [[Go documentation|https://pkg.go.dev/runtime/pprof#Profile]] for details.\n\n  This feature is dependent on the internal implementation language of Zettelstore, Go.\n  It may be removed without any further notice at any time.\n  In most cases, it is a tool for software developers to optimize Zettelstore's internal workings.\n; [!refresh|''refresh'']\n: Refresh all internal data about zettel.\n; [!restart|''restart SERVICE'']\n: Restart the given service and all other that depend on this.\n; [!services|''services'']\n: Displays s list of all available services and their current status.\n; [!set-config|''set-config SERVICE KEY VALUE'']\n: Sets a single configuration value for the next configuration of a given service.\n  It will become effective if the service is restarted.\n\n  If the key specifies a list value, all other list values with a number greater than the given key are deleted.\n  You can use the special number \"\"0\"\" to delete all values.\n  E.g. ``set-config box box-uri-0 any_text`` will remove all values of the list __box-uri-__.\n; [!shutdown|''shutdown'']\n: Terminate the Zettelstore itself (and closes the connection to the administrator console).\n; [!start|''start SERVICE'']\n: Start the given service and all dependent services.\n; [!stat|''stat SERVICE'']\n: Display some statistical values for the given service.\n; [!stop|''stop SERVICE'']\n: Stop the given service and all other that depend on this."))