cmd/tailscale: improve ip subcommand docs

Streamline the prose.
Clarify what peer may be.
Improve an error message.

Signed-off-by: Josh Bleecher Snyder <josh@tailscale.com>
pull/3392/head
Josh Bleecher Snyder 3 years ago committed by Josh Bleecher Snyder
parent a3b709f0c4
commit 73beaf59fb

@ -18,9 +18,9 @@ import (
var ipCmd = &ffcli.Command{ var ipCmd = &ffcli.Command{
Name: "ip", Name: "ip",
ShortUsage: "ip [-4] [-6] [peername]", ShortUsage: "ip [-4] [-6] [peer hostname or ip address]",
ShortHelp: "Show current Tailscale IP address(es)", ShortHelp: "Show Tailscale IP addresses",
LongHelp: "Shows the Tailscale IP address of the current machine without an argument. With an argument, it shows the IP of a named peer.", LongHelp: "Show Tailscale IP addresses for peer. Peer defaults to the current machine.",
Exec: runIP, Exec: runIP,
FlagSet: (func() *flag.FlagSet { FlagSet: (func() *flag.FlagSet {
fs := newFlagSet("ip") fs := newFlagSet("ip")
@ -37,7 +37,7 @@ var ipArgs struct {
func runIP(ctx context.Context, args []string) error { func runIP(ctx context.Context, args []string) error {
if len(args) > 1 { if len(args) > 1 {
return errors.New("unknown arguments") return errors.New("too many arguments, expected at most one peer")
} }
var of string var of string
if len(args) == 1 { if len(args) == 1 {

Loading…
Cancel
Save