From 65f3cba24823e858f019ea4c3d0b528a93251f1c Mon Sep 17 00:00:00 2001 From: Martin Levy Date: Tue, 28 Apr 2020 14:08:04 -0700 Subject: [PATCH] updated man page - back in sync with code --- cli4/cli4.man | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/cli4/cli4.man b/cli4/cli4.man index de18d1c..8214f48 100644 --- a/cli4/cli4.man +++ b/cli4/cli4.man @@ -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] @@ -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 @@ -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" @@ -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 @@ -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.