Bug 960071
| Summary: | [nmcli] enhance nmcli man page DESCRIPTION section | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 7 | Reporter: | Jirka Klimes <jklimes> |
| Component: | NetworkManager | Assignee: | Thomas Haller <thaller> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Desktop QE <desktop-qa-list> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 7.0 | CC: | dcbw, kdube, msimon, rkhan |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | nmcli-demo-0413 | ||
| Fixed In Version: | NetworkManager-0.9.9.0-10.git20130906 | Doc Type: | Bug Fix |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2014-06-13 11:58:43 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Jirka Klimes
2013-05-06 14:26:58 UTC
Some problems with the manpage: 1) it only talks about controlling and reporting on NM's status, but nmcli also includes editing and new connection features too. Basically, 'nmcli is a full featured command-line client for controlling and configuring networking with NetworkManager' or some variation on that theme. 2) it is actually meant as a full replacement for nm-applet these days, since we'll be adding a secret agent to it here at some point to handle secrets from the commandline without a GUI. A couple places talk about how the cli can't do secrets, and we should change that. 3) Should say "typical uses include" instead of "applications" 4) The use-cases should be re-arranged to be server/headless/terminal window and scripts (not initscripts), and just drop the user sessions part. We want to ensure that users know that they can edit and create connections here too, not just control them. For scripts, we want to ensure that users know that nmcli has special output formatting options to maek life easier for scripts, and it should refer to 'man NetworkManager' for more information about the dispatcher script functionality too. Please have a look at the first version: http://cgit.freedesktop.org/NetworkManager/NetworkManager/commit/?id=0926c0c0bb13eb4aab165cff32afd5ca9b9a271f , branch "thaller/cli-enhance-manpage" Some slight rewording: is a command\(hyline tool for controlling NetworkManager and reporting network status. It can be utilized as a replacement for \fInm\(hyapplet\fP or other graphical clients. \fInmcli\fP is used to create, display, edit, delete, activate, and deactivate network connections, as well as control and display network device status. --- Scripts: utilize NetworkManager via \fInmcli\fP instead of managing network connections manually. \fInmcli\fP supports a terse output format which is better suited for script processing. Note that Networkmanager can also execute scripts, called "dispatcher scripts", in response to network events. See \fBNetworkManager\fP for details about these dispatcher scripts. --- Servers, headless machines, and terminals: \fInmcli\fP can be used to control NetworkManager without a GUI, including creating, editing, starting and stopping network connections and viewing network status. THanks! I reworded the text according to comment #5 and pushed it to master. See commit 253b78312951894b0ac4ac677888c91c13d61aa9 Verified in version NetworkManager-0.9.9.0-38.git20140131.el7.x86_64. The man page of nmcli is fixed according to comments above. Moving to VERIFIED This request was resolved in Red Hat Enterprise Linux 7.0. Contact your manager or support representative in case you have further questions about the request. |