Skip to content

Commit e07d1bf

Browse files
committed
reworked documentation on unattend and unattendskip
1 parent df2a56b commit e07d1bf

2 files changed

Lines changed: 16 additions & 4 deletions

File tree

docs/CLIHELP.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -572,11 +572,17 @@ Game titles are returned from the scraping sources sometimes as 'The Game' and o
572572

573573
#### unattend
574574

575-
When generating a game list Skyscraper will check if it already exists and ask if you want to overwrite it. And it will also ask if you wish to skip existing game list entries. By using this flag Skyscraper will _always_ overwrite an existing game list and _never_ skip existing entries. This is useful when scripting Skyscraper to avoid the need for user input. Consider setting this in [`config.ini`](CONFIGINI.md#unattend) instead.
575+
Before a game list creation Skyscraper will check if it already exists and ask if you want to overwrite it, when neither `unattend` nor `unattendskip` are set. By setting this flag or `unattendskip` Skyscraper will overwrite an existing game list without confirmation question. This is useful when scripting Skyscraper to avoid the need for user input. Additionally, if this flag or `unattendskip` is set on the cache operations `purge:all` and `vacuum` you will _not_ get a confirmation question. Consider setting this in [`config.ini`](CONFIGINI.md#unattend) instead.
576576

577577
#### unattendskip
578578

579-
When generating a game list Skyscraper will check if it already exists and ask if you want to overwrite it. And it will also ask if you wish to skip existing game list entries. By using this flag Skyscraper will _always_ overwrite an existing game list and _always_ skip existing entries. This is useful when scripting Skyscraper to avoid the need for user input. Consider setting this in [`config.ini`](CONFIGINI.md#unattendskip) instead.
579+
Before a game list creation Skyscraper will ask if you want to skip existing game entries (i.e. not recreate from cache) in an existing game list, when neither `unattend` nor `unattendskip` are set. By setting this flag and not having set `unattend` Skyscraper will skip existing entries. This is useful when scripting Skyscraper to avoid the need for user input. This flag has no effect (i.e. an existing game list entry will be always recreated) when either
580+
581+
- `unattend` is set or
582+
- you use the `--query` parameter or
583+
- the frontend generator does not support preserving a complete gameentry.
584+
585+
If this flag or `unattend` is set on the cache operations `purge:all` and `vacuum` you will _not_ get a confirmation question. Consider setting this in [`config.ini`](CONFIGINI.md#unattendskip) instead.
580586

581587
#### unpack
582588

docs/CONFIGINI.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ Allowed in sections: `[main]`, `[<PLATFORM>]`
627627

628628
#### unattend
629629

630-
When generating a game list Skyscraper will check if it already exists and ask if you want to overwrite it. And it will also ask if you wish to skip existing game list entries. By enabling this option Skyscraper will _always_ overwrite an existing game list and _never_ skip existing entries, in other words: the game list will be newly created. This is flag useful for example when scripting Skyscraper to avoid the need for user input.
630+
Before a game list creation Skyscraper will check if it already exists and ask if you want to overwrite it, when neither the `unattend` nor the `unattendskip` option is set true. By setting this option or `unattendskip` to true Skyscraper will overwrite an existing game list without confirmation question. This is useful when scripting Skyscraper to avoid the need for user input. Additionally, if this option or `unattendskip` is set to true, the cache operations `purge:all` and `vacuum` will _not_ prompt you with a confirmation question.
631631

632632
Default value: `false`
633633
Allowed in sections: `[main]`, `[<PLATFORM>]`, `[<FRONTEND>]`, `[<SCRAPER>]`
@@ -636,7 +636,13 @@ Allowed in sections: `[main]`, `[<PLATFORM>]`, `[<FRONTEND>]`, `[<SCRAPER>]`
636636

637637
#### unattendSkip
638638

639-
When generating a game list Skyscraper will check if it already exists and ask if you want to overwrite it. And it will also ask if you wish to skip existing game list entries. By enabling this option Skyscraper will _always_ overwrite an existing game list and _always_ skip existing entries, in other words: game list entries are added if not present in the gamelist, existing entries are left untouched. This flag is useful for example when scripting Skyscraper to avoid the need for user input.
639+
Before a game list creation Skyscraper will ask if you want to skip existing game entries (i.e. not recreate from cache) in an existing game list, when the `unattend` and the `unattendskip` option are set false. By setting this option to true and having `unattend` set to false, Skyscraper will skip existing entries without prompting you. This is useful when scripting Skyscraper to avoid the need for user input. This option has no effect (i.e. an existing game list entry will be always recreated) when either
640+
641+
- `unattend` is set to true or
642+
- you use the `--query` parameter or
643+
- the frontend generator does not support preserving a complete gameentry.
644+
645+
If this option or the `unattend` option is true, the cache operations `purge:all` and `vacuum` will _not_ prompt you with a confirmation question.
640646

641647
Default value: `false`
642648
Allowed in sections: `[main]`, `[<PLATFORM>]`, `[<FRONTEND>]`, `[<SCRAPER>]`

0 commit comments

Comments
 (0)