sipwise
/
ngcp-panel
mirror of https://github.com/sipwise/ngcp-panel.git
1
0
Fork 0
Code Issues Releases Wiki Activity

TT#78502 Fix man pages formatting

Browse Source 
Use a correct title and NAME so that apropos can show the correct
information. Improve wording and structure of sentences. And correct
the overall markup.

Change-Id: Id9106c868b0fc556ff2529d84953feebd037029f
changes/29/39029/1
Guillem Jover 5 years ago
parent 354a25dab3
commit 624139ffcf
5 changed files with 113 additions and 84 deletions
Show Stats Download Patch File Download Diff File

27
tools_man/ngcp-api-delete.1
Unescape View File

@ -1,31 +1,34 @@
.TH NGCP-API 1
.TH NGCP-API-DELETE 1
.SH NAME
sends a delete request to NGCP REST API
ngcp-api-delete \- sends a delete request to NGCP REST API
.SH SYNOPSIS
.B ngcp-api-delete
[\fB\-v\fR]
[\fB\-h\fR]
.IR URL
.I URL
.SH DESCRIPTION
.B ngcp-api-delete
sends a delete request to NGCP REST API.
.SH OPTIONS
.TP
.BR \-v
verbose mode.
Verbose mode.
.TP
.BR \-h
print usage.
Print usage.
.TP
URL
Url for the request
.I URL
URL for the request.
.SH EXAMPLES
.TP
ngcp-api-delete 'https://example.org:1443/api/domains/1'
.EX
$ ngcp-api-delete 'https://example.org:1443/api/domains/1'
.EE
.SH SEE ALSO
.TP
ngcp-api-put(1), ngcp-api-post(1), ngcp-api-patch(1), ngcp-api-get(1)
.TP
.BR ngcp-api-put (1),
.BR ngcp-api-post (1),
.BR ngcp-api-patch (1),
.BR ngcp-api-get (1).
.PP
https://ngcp-server.domain:1443/api
.SH COPYRIGHT
2014 Sipwise Development Team <support@sipwise.com>

29
tools_man/ngcp-api-get.1
Unescape View File

@ -1,6 +1,6 @@
.TH NGCP-API 1
.TH NGCP-API-GET 1
.SH NAME
sends a get request to NGCP REST API
ngcp-api-get \- sends a get request to NGCP REST API
.SH SYNOPSIS
.B ngcp-api-get
[\fB\-v\fR]
@ -11,21 +11,24 @@ sends a get request to NGCP REST API
sends a get request to NGCP REST API.
.SH OPTIONS
.TP
.BR \-v
verbose mode.
.B \-v
Verbose mode.
.TP
.BR \-h
print usage.
.B \-h
Print usage.
.TP
URL
Url for the request
.I URL
URL for the request.
.SH EXAMPLES
.TP
ngcp-api-get 'https://example.org:1443/api/domains/'
.EX
$ ngcp-api-get 'https://example.org:1443/api/domains/'
.EE
.SH SEE ALSO
.TP
ngcp-api-put(1), ngcp-api-post(1), ngcp-api-patch(1), ngcp-api-delete(1)
.TP
.BR ngcp-api-put (1),
.BR ngcp-api-post (1),
.BR ngcp-api-patch (1),
.BR ngcp-api-delete (1).
.PP
https://ngcp-server.domain:1443/api
.SH COPYRIGHT
2014 Sipwise Development Team <support@sipwise.com>

42
tools_man/ngcp-api-patch.1
Unescape View File

@ -1,6 +1,6 @@
.TH NGCP-API 1
.TH NGCP-API-PATCH 1
.SH NAME
sends a patch request to NGCP REST API
ngcp-api-patch \- sends a patch request to NGCP REST API
.SH SYNOPSIS
.B ngcp-api-patch
[\fB\-f\fR \fIFILEPATH\fR]
@ -13,28 +13,34 @@ sends a patch request to NGCP REST API
sends a patch request to NGCP REST API.
.SH OPTIONS
.TP
.BR \-f " " \fIFILEPATH\fR
use input file instead of stdin.
.BI \-f " FILEPATH"
Use
.I FILEPATH
as input file instead of stdin.
.TP
.BR \-m
Use Header 'Refer: return=minimal'. Default is 'Refer: return=representation'
.B \-m
Use the Header 'Refer: return=minimal'.
Default is 'Refer: return=representation'
.TP
.BR \-v
verbose mode.
.B \-v
Verbose mode.
.TP
.BR \-h
print usage.
.B \-h
Print usage.
.TP
URL
Url for the request
.I URL
URL for the request.
.SH EXAMPLES
.TP
echo '[ { "op" : "remove", "path" : "/active" } ]'|\\
ngcp-api-patch 'https://example.org:1443/api/faxserversettings/2'
.EX
$ echo '[ { "op" : "remove", "path" : "/active" } ]'\\
| ngcp-api-patch 'https://example.org:1443/api/faxserversettings/2'
.EE
.SH SEE ALSO
.TP
ngcp-api-put(1), ngcp-api-post(1), ngcp-api-delete(1), ngcp-api-get(1)
.TP
.BR ngcp-api-put (1),
.BR ngcp-api-post (1),
.BR ngcp-api-delete (1),
.BR ngcp-api-get (1).
.PP
https://ngcp-server.domain:1443/api
.SH COPYRIGHT
2014 Sipwise Development Team <support@sipwise.com>

51
tools_man/ngcp-api-post.1
Unescape View File

@ -1,42 +1,51 @@
.TH NGCP-API 1
.TH NGCP-API-POST 1
.SH NAME
sends a post request to NGCP REST API
ngcp-api-post \- sends a post request to NGCP REST API
.SH SYNOPSIS
.B ngcp-api-post
[\fB\-f\fR \fIFILEPATH\fR]
[\fB\-v\fR]
[\fB\-h\fR]
.IR URL
[content_type]
.I URL
.RI [ CONTENT-TYPE ]
.SH DESCRIPTION
.B ngcp-api-post
sends a post request to NGCP REST API.
.SH OPTIONS
.TP
.BR \-f " " \fIFILEPATH\fR
use input file instead of stdin.
.BI \-f " FILEPATH"
Use
.I FILEPATH
as input file instead of stdin.
.TP
.BR \-v
verbose mode.
.B \-v
Verbose mode.
.TP
.BR \-h
print usage.
.B \-h
Print usage.
.TP
URL
Url for the request
.I URL
URL for the request.
.TP
content_type
The default is 'application/json'
.I CONTENT-TYPE
Specifies the HTTP content-type.
The default is
.RI ' application/json '.
.SH EXAMPLES
.TP
echo '{ "domain" : "test", "reseller_id" : 4 }' \\
.EX
$ echo '{ "domain" : "test", "reseller_id" : 4 }' \\
| ngcp-api-post https://127.0.0.1:1443/api/domains/
.TP
ngcp-api-post -f ../test_post.txt https://127.0.0.1:1443/api/domains/ 'application/json'
.EE
.PP
.EX
$ ngcp-api-post -f ../test_post.txt https://127.0.0.1:1443/api/domains/ 'application/json'
.EE
.SH SEE ALSO
.TP
ngcp-api-get(1), ngcp-api-put(1), ngcp-api-patch(1), ngcp-api-delete(1)
.TP
.BR ngcp-api-get (1),
.BR ngcp-api-put (1),
.BR ngcp-api-patch (1),
.BR ngcp-api-delete (1).
.PP
https://ngcp-server.domain:1443/api
.SH COPYRIGHT
2014 Sipwise Development Team <support@sipwise.com>

48
tools_man/ngcp-api-put.1
Unescape View File

@ -1,42 +1,50 @@
.TH NGCP-API 1
.TH NGCP-API-PUT 1
.SH NAME
sends a put request to NGCP REST API
ngcp-api-put \- sends a put request to NGCP REST API
.SH SYNOPSIS
.B ngcp-api-put
[\fB\-f\fR \fIFILEPATH\fR]
[\fB\-v\fR]
[\fB\-h\fR]
.IR URL
[content_type]
.RI [ CONTENT-TYPE ]
.SH DESCRIPTION
.B ngcp-api-put
sends a put request to NGCP REST API.
.SH OPTIONS
.TP
.BR \-f " " \fIFILEPATH\fR
use input file instead of stdin.
.BI \-f " FILEPATH"
Use
.I FILEPATH
as input file instead of stdin.
.TP
.BR \-v
verbose mode.
.B \-v
Verbose mode.
.TP
.BR \-h
print usage.
.B \-h
Print usage.
.TP
URL
Url for the request
.I URL
URL for the request
.TP
content_type
.I CONTENT-TYPE
Specifies the HTTP content-type.
The default is 'application/json'
.SH EXAMPLES
.TP
echo '{"body":"test","from_email":"test","name":"test","reseller_id":4,"subject":"test"}'\\
|ngcp-api-put 'https://example.org:1443/api/emailtemplates/2'
.TP
ngcp-api-put -f ../test_put.json https://127.0.0.1:1443/api/domains/ 'application/json'
.EX
$ echo '{"body":"test","from_email":"test","name":"test","reseller_id":4,"subject":"test"}'\\
| ngcp-api-put 'https://example.org:1443/api/emailtemplates/2'
.EE
.PP
.EX
$ ngcp-api-put -f ../test_put.json https://127.0.0.1:1443/api/domains/ 'application/json'
.EE
.SH SEE ALSO
.TP
ngcp-api-get(1), ngcp-api-post(1), ngcp-api-patch(1), ngcp-api-delete(1)
.TP
.BR ngcp-api-get (1),
.BR ngcp-api-post (1),
.BR ngcp-api-patch (1),
.BR ngcp-api-delete (1).
.PP
https://ngcp-server.domain:1443/api
.SH COPYRIGHT
2014 Sipwise Development Team <support@sipwise.com>

Write Preview
Loading…
Cancel
Save