generate

Documentation

Index

• Constants
• type Cmd
  • func (cmd *Cmd) Run()

Constants

const Description = "The generate subcommand will generate a location or city XML " +
	"stanza based on a provided OpenStreetMap URL. " +
	"This command expects to be given an OSM URL of the form: " +
	"https://www.openstreetmap.org/<type>/<ID>. The type will be one of " +
	"N(ode), W(ay) or R(elation). The ID is a sequence of numbers. " +
	"The protocol and hostname may be omitted, as well as the first '/', " +
	"so values like /<type>/<ID> or <type>/<ID> are also valid. The URL " +
	"can also include query parameters or URL fragments.\n\n" +

	"To find the right URL, head to https://www.openstreetmap.org and search for something " +
	"in the search box. Pick the best matching result and use that URL as an argument to this command. " +
	"If a provided URL cannot be determined to be an airport, we'll assume this is a city.\n\n" +

	"For cities, ensure you supply a URL that points to the city, and not a similarly named " +
	"municipality. In some cases, you'll want to pick the Village or Village Boundary instead of the City " +
	"from the provided search results.\n\n" +

	"For airports, ensure you supply a URL that points to the airport, and not an airport " +
	"terminal or adjacent transit location (like a bus stop or train station).\n\n" +

	"For each provided URL, it will try to fetch details about the object and generate " +
	"a <location> or <city> XML stanza suitable for inclusion in libgweather.\n"

Types

type Cmd

type Cmd struct {
	OSMURL    []string `arg:"positional,required" placeholder:"URL" help:"OSM URL to generate location or city from"`
	UAVersion string   `arg:"-"`
}

func (*Cmd) Run

func (cmd *Cmd) Run()