After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 739710 - [patch] add manual page for nmtui(1)
[patch] add manual page for nmtui(1)
Status: RESOLVED FIXED
Product: NetworkManager
Classification: Platform
Component: Documentation
git master
Other Linux
: Normal normal
: ---
Assigned To: NetworkManager maintainer(s)
NetworkManager maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2014-11-06 07:27 UTC by Thomas Haller
Modified: 2014-11-11 15:03 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
man: add manual page for nmtui(1) (3.28 KB, patch)
2014-11-06 07:29 UTC, Thomas Haller 		reviewed Details | Review

Description Thomas Haller 2014-11-06 07:27:53 UTC 
nmtui should have a manual page.

Please have a look at the patch.
Yes, the text is improvable, it's a first shot.


I guess, we would also need manual pages for nmtui-connect, nmtui-edit, nmtui-hostname...
Comment 1 Thomas Haller 2014-11-06 07:29:55 UTC 
Created attachment 290072 [details] [review]
man: add manual page for nmtui(1)

https://bugzilla.gnome.org/show_bug.cgi?id=739710

Signed-off-by: Thomas Haller <thaller@redhat.com>
Comment 2 Dan Winship 2014-11-06 13:28:59 UTC 
Comment on attachment 290072 [details] [review]
man: add manual page for nmtui(1)

> configure_generated_man_pages =		\
> 	nmcli.1				\
>+	nmtui.1				\

As you suggested, we should install symlinks for nmtui-connect.1, nmtui-edit.1, and nmtui-hostname.1

>+.SH SYNOPSIS
>+.B nmtui
>+.P
>+.B nmtui\-edit
>+.P
>+.B nmtui\-connect
>+.P
>+.B nmtui\-hostname

The subcommands take optional arguments:

  nmtui-edit [ connection name | connection uuid ]
  nmtui-connect [ connection name | connection uuid | device name | Wi-Fi SSID ]

And you can also pass the subcommand as an argument to plain "nmtui" rather than using one of the symlinks:

  nmtui [ edit | connect | hostname ] ...

>+is a curser\(hybased TUI application to add, view, modify, and delete connections,

"curses"

>+activate and deactivate connections and to set the hostname.

I'm not sure I'd enumerate all the things it does here... we might add more in the future. Just say "a curses-based TUI application for interacting with NetworkManager" or something.

> \fInmtui\fP can also ask the user for required secrets.

I don't think we need to say that, especially since as of 1.0, that will be true for all clients.

>+When starting \fInmtui\fP, the user is prompted to choose one of the following activities:

(if they didn't specify a subcommand on the command line)

>+.IP \(em 4
>+\fIedit\fP: show a connection editor that supports adding, modifying, viewer and deleting

"viewing"

maybe add "like nm-connection-editor"

>+\fIconnect\fP: show a list of available connections and the option to activate or deactivate
>+them.

change "and" to ", with"

and again, also maybe "like nm-applet"
Comment 3 Thomas Haller 2014-11-10 17:06:32 UTC 
Dan, I addressed your points.

Pushed new version to branch "th/bgo739710_man_nmtui"
Comment 4 Dan Winship 2014-11-11 14:33:18 UTC 
looks good