Skip to content

Commit

Permalink
updated man page - back in sync with code
Browse files Browse the repository at this point in the history
  • Loading branch information
mahtin committed Apr 28, 2020
1 parent 13901c1 commit 65f3cba
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions cli4/cli4.man
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
.TH CLI4 1

.SH NAME
cli4 \- Command line access to CloudFlare v4 API
cli4 \- Command line access to Cloudflare v4 API

.SH SYNOPSIS
.B cli4
[\fB\-V\fR]
[\fB\-V\fR|\fB\-\-version]
[\fB\-h\fR|\fB\-\-help]
[\fB\-v\fR|\fB\-\-verbose]
[\fB\-q\fR|\fB\-\-quiet]
[\fB\-j\fR|\fB\-\-json]
[\fB\-y\fR|\fB\-\-yaml]
[\fB\-n\fR|\fB\-\-ndjson]
[\fB\-r\fR|\fB\-\-raw]
[\fB\-d\fR|\fB\-\-dump]
[\fB\-p profile-name\fR|\fB\-\-profile profile-name]
[\fBitem\fR=\fIvalue\fR ...]
[\fBitem\fR=@\fIfilename\fR ...]
[\fB\-G\fR|\fB\-\-get]
[\fB\-P\fR|\fB\-\-patch]
[\fB\-O\fR|\fB\-\-post]
Expand All @@ -22,7 +26,7 @@ cli4 \- Command line access to CloudFlare v4 API

.SH DESCRIPTION
.B cli4
provides command line access to CloudFlare v4 API
provides command line access to Cloudflare v4 API

.SH OPTIONS
.TP
Expand All @@ -40,6 +44,12 @@ Output response data in JSON format (the default).
Output response data in YAML format (if yaml package installed).
.IP "[\-n, \-\-ndjson]"
Output response data in NDJSON format (if jsonlines package installed).
.IP "[\-r, \-\-raw]"
Output JSON results in raw mode without splitting out the errors and results.
.IP "[\-d, \-\-dump]"
Output a list of all API calls included in the code.
.IP "[-p \fIprofile-name\fR, \-\-profile \fIprofile-name\fR]"
Select a \fIprofile-name\fR from the configuration file (hence select custom \fIemail\fR/\fItoken\fR values).
.IP "\-\-get"
Send HTTP request as a \fBGET\fR (the default).
.IP "\-\-patch"
Expand All @@ -54,9 +64,13 @@ Send HTTP request as a \fBDELETE\fR.
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.
.IP item:=\fIvalue\fR
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.
.IP /command...
The API command.
The command uses slash (\fB/\fR) to seperate the verbs in the same way that the CloudFlare v4 API documentation does.
.IP item=@\fIfilename\fR
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.
.IP "\fI/command ...\fR"
The API command(s) to execute.

.SH COMMAND(S)
The command string uses slash (\fB/\fR) to seperate the verbs in the same way that the Cloudflare v4 API documentation does.
Any verb starting with colon (\fB:\fR) is either converted to zone_id, user_id, organtization_id, or otherwise.

.SH RESULTS
Expand Down Expand Up @@ -94,4 +108,4 @@ Make DNSSEC active for specfic zone.
List DNSSEC infomation and status for a specific zone.

.SH SEE ALSO
The CloudFlare API can be found https://api.cloudflare.com/. Each API call is provided via a similarly named function within the CloudFlare class.
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 comments on commit 65f3cba

Please sign in to comment.