Skip to content
This repository was archived by the owner on Nov 22, 2024. It is now read-only.

Commit 65f3cba

Browse files
committed
updated man page - back in sync with code
1 parent 13901c1 commit 65f3cba

1 file changed

Lines changed: 21 additions & 7 deletions

File tree

cli4/cli4.man

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
.TH CLI4 1
22

33
.SH NAME
4-
cli4 \- Command line access to CloudFlare v4 API
4+
cli4 \- Command line access to Cloudflare v4 API
55

66
.SH SYNOPSIS
77
.B cli4
8-
[\fB\-V\fR]
8+
[\fB\-V\fR|\fB\-\-version]
99
[\fB\-h\fR|\fB\-\-help]
1010
[\fB\-v\fR|\fB\-\-verbose]
1111
[\fB\-q\fR|\fB\-\-quiet]
1212
[\fB\-j\fR|\fB\-\-json]
1313
[\fB\-y\fR|\fB\-\-yaml]
1414
[\fB\-n\fR|\fB\-\-ndjson]
15+
[\fB\-r\fR|\fB\-\-raw]
16+
[\fB\-d\fR|\fB\-\-dump]
17+
[\fB\-p profile-name\fR|\fB\-\-profile profile-name]
1518
[\fBitem\fR=\fIvalue\fR ...]
19+
[\fBitem\fR=@\fIfilename\fR ...]
1620
[\fB\-G\fR|\fB\-\-get]
1721
[\fB\-P\fR|\fB\-\-patch]
1822
[\fB\-O\fR|\fB\-\-post]
@@ -22,7 +26,7 @@ cli4 \- Command line access to CloudFlare v4 API
2226

2327
.SH DESCRIPTION
2428
.B cli4
25-
provides command line access to CloudFlare v4 API
29+
provides command line access to Cloudflare v4 API
2630

2731
.SH OPTIONS
2832
.TP
@@ -40,6 +44,12 @@ Output response data in JSON format (the default).
4044
Output response data in YAML format (if yaml package installed).
4145
.IP "[\-n, \-\-ndjson]"
4246
Output response data in NDJSON format (if jsonlines package installed).
47+
.IP "[\-r, \-\-raw]"
48+
Output JSON results in raw mode without splitting out the errors and results.
49+
.IP "[\-d, \-\-dump]"
50+
Output a list of all API calls included in the code.
51+
.IP "[-p \fIprofile-name\fR, \-\-profile \fIprofile-name\fR]"
52+
Select a \fIprofile-name\fR from the configuration file (hence select custom \fIemail\fR/\fItoken\fR values).
4353
.IP "\-\-get"
4454
Send HTTP request as a \fBGET\fR (the default).
4555
.IP "\-\-patch"
@@ -54,9 +64,13 @@ Send HTTP request as a \fBDELETE\fR.
5464
Set a paramater or data value to send with a \fBGET\fR, \fBPATCH\fR, \fBPOST\fR, \fBPUT\fR or \fBDELETE\fR command. The value is sent as a string.
5565
.IP item:=\fIvalue\fR
5666
Set a paramater or data value to send with a \fBGET\fR, \fBPATCH\fR, \fBPOST\fR, \fBPUT\fR or \fBDELETE\fR command. The value is sent as an interger.
57-
.IP /command...
58-
The API command.
59-
The command uses slash (\fB/\fR) to seperate the verbs in the same way that the CloudFlare v4 API documentation does.
67+
.IP item=@\fIfilename\fR
68+
Set a paramater or data value to send with a \fBPOST\fR or \fBPUT\fR command. The value is based on the content of the file.
69+
.IP "\fI/command ...\fR"
70+
The API command(s) to execute.
71+
72+
.SH COMMAND(S)
73+
The command string uses slash (\fB/\fR) to seperate the verbs in the same way that the Cloudflare v4 API documentation does.
6074
Any verb starting with colon (\fB:\fR) is either converted to zone_id, user_id, organtization_id, or otherwise.
6175

6276
.SH RESULTS
@@ -94,4 +108,4 @@ Make DNSSEC active for specfic zone.
94108
List DNSSEC infomation and status for a specific zone.
95109

96110
.SH SEE ALSO
97-
The CloudFlare API can be found https://api.cloudflare.com/. Each API call is provided via a similarly named function within the CloudFlare class.
111+
The Cloudflare API can be found https://api.cloudflare.com/. Each API call is provided via a similarly named function within the Cloudflare class.

0 commit comments

Comments
 (0)