mirror/php-rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-08-08 17:46:34 +02:00
Code Issues Releases Wiki Activity

docs

Browse Source 
* refactor

* docs
This commit is contained in:
Dag
2024-08-30 04:37:40 +02:00
committed by GitHub
parent 6a24e53d6c
commit 9cabf60144
11 changed files with 64 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/02_CLI/index.md
View File

@@ -1,10 +1,12 @@
RSS-Bridge supports calls via CLI. You can use the same parameters as you would normally use via the URI. Example:
RSS-Bridge supports calls via CLI.
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:
RSS-Bridge requires a few parameters that must be specified on every call.
Omitting these parameters will result in error messages:
### action
@@ -17,20 +19,26 @@ Value | Description
### 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.
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`.
This parameter specifies the format in which RSS-Bridge returns the contents.
## Optional parameters
RSS-Bridge supports optional parameters. These parameters are only valid if the options have been enabled in the index.php script.
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.by_bridge` has been enabled. This is a Boolean parameter that can be set to `true` or `false`.
This parameter is only available if a proxy server has been specified via `proxy.url` and `proxy.by_bridge`
has been enabled. This is a Boolean parameter that can be set to `true` or `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.
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.