From d68cc9e01807eefe799ab64f60605d2a5093c1db Mon Sep 17 00:00:00 2001 From: LogMANOriginal Date: Sun, 11 Mar 2018 13:07:20 +0100 Subject: [PATCH] [CLI] Add new page --- Command-Line-Interface-(CLI).md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 Command-Line-Interface-(CLI).md diff --git a/Command-Line-Interface-(CLI).md b/Command-Line-Interface-(CLI).md new file mode 100644 index 0000000..0617b6e --- /dev/null +++ b/Command-Line-Interface-(CLI).md @@ -0,0 +1,33 @@ +RSS-Bridge supports the CLI of php. You can use the same parameters as you would normally use via the URI: + +Example: + +`php index.php action=display bridge=DansTonChat format=Json` + +## Required parameters + +RSS-Bridge requires a few parameters that must be specified on every call. Omitting these parameters will result in error messages: + +### action + +The `action` parameter specifies the action RSS-Bridge should take. Currently this parameter only supports the value `display` which causes RSS-Bridge to return the feed contents. + +### bridge + +This parameter specifies the name of the bridge RSS-Bridge should return feeds from. The name of the bridge equals the class name of the bridges in the ./bridges/ folder without the 'Bridge' prefix. For example: DansTonChatBridge => DansTonChat. + +### format + +This parameter specifies the format in which RSS-Bridge returns the contents. RSS-Bridge currently supports five formats: `Atom`, `Html`, `Json`, `Mrss`and `Plaintext`. + +## Optional parameters + +RSS-Bridge supports optional parameters. These parameters are only valid if the options have been enabled in the index.php script. + +### _noproxy + +This parameter is only available if a proxy server has been specified via `PROXY_URL` and 'PROXY_BYBRIDGE' has been enabled. This is a Boolean parameter that can be set to '1' (true) or '0' (false). + +## Bridge parameters + +Each bridge can specify its own set of parameters. As in the example above, some bridges don't specify any parameters or only optional parameters that can be neglected. For more details read the `PARAMETERS` definition for your bridge. \ No newline at end of file