tsarevvv/nmstate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

nmstate-varlink: Updated manpage for nmstate-varlink service

Browse Source 
Updated the manpage for nmstate-varlink service.

Signed-off-by: Arunagirinadan Sudharshan <sudhan.aruna.97@gmail.com>
This commit is contained in:
Arunagirinadan Sudharshan 2020-08-24 23:43:37 +05:30 committed by Gris Ge
parent c219bc043b
commit d50eb00552
1 changed files with 14 additions and 0 deletions

14
doc/nmstatectl.8.in

@ -14,6 +14,8 @@ nmstatectl \- A nmstate command line tool
.B nmstatectl commit \fR[\fICHECKPOINT_PATH\fR]
.br
.B nmstatectl version
.br
.B nmstatectl varlink \fR[\fIUNIX_FILE_SOCKET_PATH\fR]
.SH DESCRIPTION
.B nmstatectl\fR is created for users who want to try out nmstate without using
\fIlibnmstate\fR.
@ -81,6 +83,18 @@ checkpoint if not defined as argument.
.B version
.RS
displays nmstate version.
.RE
.PP
.B varlink
.RS
Initates the nmstate-varlink service in the specified unix file socket path
supporting the libnmstate functions (Show, Apply, Commit and Rollback).
This enables functions to be accessed via varlink command-line tool and client implementations.
Currently the service is limited to using unix file socket address only.
.PP
example: nmstatectl varlink /run/nmstate.so &
.PP
.RE
.SH OPTIONS
.B --json
.RS