mirror of
https://github.com/rclone/rclone.git
synced 2024-12-01 21:04:56 +01:00
bff702a6f1
This adds an additional parameter to the creation of each flag. This specifies one or more flag groups. This **must** be set for global flags and **must not** be set for local flags. This causes flags.md to be built with sections to aid comprehension and it causes the documentation pages for each command (and the `--help`) to be built showing the flags groups as specified in the `groups` annotation on the command. See: https://forum.rclone.org/t/make-docs-for-mortals-not-only-rclone-gurus/39476/
63 lines
2.1 KiB
Go
63 lines
2.1 KiB
Go
// Package dlnaflags provides utility functionality to DLNA.
|
|
package dlnaflags
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/rclone/rclone/fs/config/flags"
|
|
"github.com/rclone/rclone/fs/rc"
|
|
"github.com/spf13/pflag"
|
|
)
|
|
|
|
// Help contains the text for the command line help and manual.
|
|
var Help = `
|
|
### Server options
|
|
|
|
Use ` + "`--addr`" + ` to specify which IP address and port the server should
|
|
listen on, e.g. ` + "`--addr 1.2.3.4:8000` or `--addr :8080`" + ` to listen to all
|
|
IPs.
|
|
|
|
Use ` + "`--name`" + ` to choose the friendly server name, which is by
|
|
default "rclone (hostname)".
|
|
|
|
Use ` + "`--log-trace` in conjunction with `-vv`" + ` to enable additional debug
|
|
logging of all UPNP traffic.
|
|
`
|
|
|
|
// Options is the type for DLNA serving options.
|
|
type Options struct {
|
|
ListenAddr string
|
|
FriendlyName string
|
|
LogTrace bool
|
|
InterfaceNames []string
|
|
AnnounceInterval time.Duration
|
|
}
|
|
|
|
// DefaultOpt contains the defaults options for DLNA serving.
|
|
var DefaultOpt = Options{
|
|
ListenAddr: ":7879",
|
|
FriendlyName: "",
|
|
LogTrace: false,
|
|
InterfaceNames: []string{},
|
|
AnnounceInterval: 12 * time.Minute,
|
|
}
|
|
|
|
// Opt contains the options for DLNA serving.
|
|
var (
|
|
Opt = DefaultOpt
|
|
)
|
|
|
|
func addFlagsPrefix(flagSet *pflag.FlagSet, prefix string, Opt *Options) {
|
|
rc.AddOption("dlna", &Opt)
|
|
flags.StringVarP(flagSet, &Opt.ListenAddr, prefix+"addr", "", Opt.ListenAddr, "The ip:port or :port to bind the DLNA http server to", prefix)
|
|
flags.StringVarP(flagSet, &Opt.FriendlyName, prefix+"name", "", Opt.FriendlyName, "Name of DLNA server", prefix)
|
|
flags.BoolVarP(flagSet, &Opt.LogTrace, prefix+"log-trace", "", Opt.LogTrace, "Enable trace logging of SOAP traffic", prefix)
|
|
flags.StringArrayVarP(flagSet, &Opt.InterfaceNames, prefix+"interface", "", Opt.InterfaceNames, "The interface to use for SSDP (repeat as necessary)", prefix)
|
|
flags.DurationVarP(flagSet, &Opt.AnnounceInterval, prefix+"announce-interval", "", Opt.AnnounceInterval, "The interval between SSDP announcements", prefix)
|
|
}
|
|
|
|
// AddFlags add the command line flags for DLNA serving.
|
|
func AddFlags(flagSet *pflag.FlagSet) {
|
|
addFlagsPrefix(flagSet, "", &Opt)
|
|
}
|