Skip to content

Commit d9ce2f4

Browse files
committed
docs
1 parent 2a36425 commit d9ce2f4

2 files changed

Lines changed: 18 additions & 22 deletions

File tree

resources/docs/Documentation.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -162,11 +162,11 @@ You can download up to 6 files simultaneously.
162162
You can find its settings in `Web browser & tabs` section of main menu.
163163

164164
## GUI tweaking
165-
RSS Guard's GUI is very customizable. You can, for example, hide many GUI elements.
165+
RSS Guard's GUI is very customizable. You can, for example, hide many GUI elements. There are even people who use RSS Guard on mobile devices powered by Linux like PinePhone or Librem devices.
166166

167167
<img src="images/gui-hiding.png" width="80%">
168168

169-
For example, you can hide menu, toolbars, status bar and even list headers to achieve very minimal main window layout.
169+
For example, you can hide menu, various toolbars, statusbar and even list headers to achieve very minimal main window layout.
170170

171171
If you hide main menu, then small `home` icon will appear in left-top corner of main application window.
172172

@@ -180,16 +180,21 @@ Many people have very widescreen monitors nowadays and RSS Guard offers you hori
180180
Here you can find some useful insights into RSS Guard's modus operandi.
181181

182182
## CLI
183-
RSS Guard offers CLI (command line interface). For overview if its features, run `rssguard --help` in your terminal. You will see the overview of the interface.
183+
RSS Guard offers CLI (command line interface). For overview of its features, run `rssguard --help` in your terminal. You will see the overview of the interface.
184184

185185
```
186186
RSS Guard
187187
188188
Options:
189-
-l, --log <log-file> Write application debug log to file.
190-
-?, -h, --help Displays help on commandline options.
191-
--help-all Displays help including Qt specific options.
192-
-v, --version Displays version information.
189+
-l, --log <log-file> Write application debug log to file. Note that
190+
logging to file may slow application down.
191+
-d, --data <user-data-folder> Use custom folder for user data and disable
192+
single instance application mode.
193+
-s, --no-single-instance Allow running of multiple application
194+
instances.
195+
-?, -h, --help Displays help on commandline options.
196+
--help-all Displays help including Qt specific options.
197+
-v, --version Displays version information.
193198
```
194199

195200
## Cleaning database
@@ -224,17 +229,8 @@ Here is the rough workflow which is done when you hit `Feeds & categories -> Upd
224229
If you run into problems with RSS Guard and you need your problems fixed, you should provide log file from the time when problem occurred. RSS Guard writes all important information to standard output, which is usually calling terminal.
225230

226231
To redirect debug output of RSS Guard to log file, do this:
227-
228-
* Windows
229-
1. You need to open command line, run `CTRL + R` and write `cmd`.
230-
2. Navigate to your RSS Guard installation folder, `cd C:\Programs\rssguard\`. This is the folder which contains `rssguard.exe`.
231-
3. Enter `.\rssguard.exe --log '.\log.txt'`. RSS Guard will now start. You can of course specify arbitrary file where to store log and its location must be writable. The `--log` syntax is supported starting from RSS Guard 3.8.0. Older versions do not support capturing debug output.
232-
4. Now try to simulate your problem.
233-
5. Attach generated `log.txt` file to your bug report.
234-
235-
* Linux
236-
1. You need to open command line, run terminal emulator.
237-
2. Navigate to your RSS Guard installation folder, `cd /my/root/rssguard'. This step is not usually needed.
238-
3. Enter `rssguard > /home/<user>/log.txt 2>&1`. RSS Guard will now start.
239-
4. Now try to simulate your problem.
240-
5. Attach generated `log.txt` file to your bug report.
232+
1. Open command line.
233+
2. Navigate to your RSS Guard installation folder.
234+
3. Enter `rssguard.exe --log 'log.txt'`. RSS Guard will now start. You can of course specify arbitrary file where to store log and its location must be writable.
235+
4. Now try to simulate your problem.
236+
5. Attach generated `log.txt` file to your bug report.

resources/docs/Feed-formats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ Standard plugin offers some extra features like export/import of OPML 2.0 files
2525
OPML files can be exported/imported in simple dialog.
2626

2727
<img src="images/im-ex-feeds.png" width="80%">
28-
<img src="images/im-ex-feeds-dialog.png">
28+
<img src="images/im-ex-feeds-dialog.png" width="50%">
2929

3030
You just select output file (in case of OPML export), check desired feeds and hit `Export to file`.

0 commit comments

Comments
 (0)