mirror of
https://github.com/fiso64/slsk-batchdl.git
synced 2025-01-08 06:22:43 +00:00
update help
This commit is contained in:
parent
2fbec8e811
commit
15a8f0604e
2 changed files with 18 additions and 14 deletions
10
README.md
10
README.md
|
@ -295,7 +295,7 @@ file containing lines of the following form:
|
||||||
# input conditions pref. conditions
|
# input conditions pref. conditions
|
||||||
artist=Artist,album=Album format=mp3;br>128 "br >= 320"
|
artist=Artist,album=Album format=mp3;br>128 "br >= 320"
|
||||||
```
|
```
|
||||||
The inputs can be any of the above input types. The conditions are added on top of the
|
The input can be any of the above input types. The conditions are added on top of the
|
||||||
configured conditions and can be omitted.
|
configured conditions and can be omitted.
|
||||||
For album downloads, the above example can be written briefly as `a:"Artist - Album"` (note
|
For album downloads, the above example can be written briefly as `a:"Artist - Album"` (note
|
||||||
that `a:` must appear outside the quotes).
|
that `a:` must appear outside the quotes).
|
||||||
|
@ -321,8 +321,8 @@ all songs by an artist.
|
||||||
Activated when both `--album` and `--aggregate` are enabled. sldl will group shares and
|
Activated when both `--album` and `--aggregate` are enabled. sldl will group shares and
|
||||||
download one of each distinct album, starting with the one shared by the most users. Note
|
download one of each distinct album, starting with the one shared by the most users. Note
|
||||||
that `--min-shares-aggregate` is 2 by default, meaning that albums shared by only one user
|
that `--min-shares-aggregate` is 2 by default, meaning that albums shared by only one user
|
||||||
will be ignored. Album-aggregate mode can be used to (for example) download all albums by an
|
will be ignored. Album-aggregate mode can be used to (for example) download the most popular
|
||||||
artist. It is recommended to pair it with `--interactive`.
|
albums by an artist. It is recommended to pair it with `--interactive`.
|
||||||
|
|
||||||
## Searching
|
## Searching
|
||||||
|
|
||||||
|
@ -354,8 +354,8 @@ instability:
|
||||||
## File conditions
|
## File conditions
|
||||||
|
|
||||||
Files not satisfying the required conditions will be ignored. Files satisfying pref-conditions
|
Files not satisfying the required conditions will be ignored. Files satisfying pref-conditions
|
||||||
will be preferred: With `--pref-format flac,wav` sldl will try to download lossless files if
|
will be preferred: With `--pref-format flac,wav`, sldl will try to download lossless files if
|
||||||
available, but still accept lossy files.
|
available while still accepting lossy files.
|
||||||
|
|
||||||
There are no default required conditions. The default preferred conditions are:
|
There are no default required conditions. The default preferred conditions are:
|
||||||
```
|
```
|
||||||
|
|
|
@ -266,7 +266,7 @@ public static class Help
|
||||||
# input conditions pref. conditions
|
# input conditions pref. conditions
|
||||||
artist=Artist,album=Album format=mp3;br>128 ""br >= 320""
|
artist=Artist,album=Album format=mp3;br>128 ""br >= 320""
|
||||||
|
|
||||||
The inputs can be any of the above input types. The conditions are added on top of the
|
The input can be any of the above input types. The conditions are added on top of the
|
||||||
configured conditions and can be omitted.
|
configured conditions and can be omitted.
|
||||||
For album downloads, the above example can be written briefly as `a:""Artist - Album""` (note
|
For album downloads, the above example can be written briefly as `a:""Artist - Album""` (note
|
||||||
that `a:` must appear outside the quotes).
|
that `a:` must appear outside the quotes).
|
||||||
|
@ -294,8 +294,8 @@ public static class Help
|
||||||
Activated when both `--album` and `--aggregate` are enabled. sldl will group shares and
|
Activated when both `--album` and `--aggregate` are enabled. sldl will group shares and
|
||||||
download one of each distinct album, starting with the one shared by the most users. Note
|
download one of each distinct album, starting with the one shared by the most users. Note
|
||||||
that `--min-shares-aggregate` is 2 by default, meaning that albums shared by only one user
|
that `--min-shares-aggregate` is 2 by default, meaning that albums shared by only one user
|
||||||
will be ignored. Album-aggregate mode can be used to (for example) download all albums by an
|
will be ignored. Album-aggregate mode can be used to (for example) download the most popular
|
||||||
artist. It is recommended to pair it with `--interactive`.
|
albums by an artist. It is recommended to pair it with `--interactive`.
|
||||||
";
|
";
|
||||||
|
|
||||||
const string searchHelp = @"
|
const string searchHelp = @"
|
||||||
|
@ -331,8 +331,8 @@ public static class Help
|
||||||
File conditions
|
File conditions
|
||||||
|
|
||||||
Files not satisfying the required conditions will be ignored. Files satisfying pref-conditions
|
Files not satisfying the required conditions will be ignored. Files satisfying pref-conditions
|
||||||
will be preferred: With `--pref-format flac,wav` sldl will try to download lossless files if
|
will be preferred: With `--pref-format flac,wav`, sldl will try to download lossless files if
|
||||||
available, but still accept lossy files.
|
available while still accepting lossy files.
|
||||||
|
|
||||||
There are no default required conditions. The default preferred conditions are:
|
There are no default required conditions. The default preferred conditions are:
|
||||||
|
|
||||||
|
@ -438,8 +438,8 @@ public static class Help
|
||||||
[lossless]
|
[lossless]
|
||||||
pref-format = flac,wav
|
pref-format = flac,wav
|
||||||
|
|
||||||
To activate the above profile, run --profile ""lossless"". To list all available profiles,
|
To activate the above profile, run `--profile lossless`. To list all available profiles,
|
||||||
run --profile ""help"".
|
run `--profile help`.
|
||||||
Profiles can be activated automatically based on a few simple conditions:
|
Profiles can be activated automatically based on a few simple conditions:
|
||||||
|
|
||||||
[no-stale]
|
[no-stale]
|
||||||
|
@ -501,10 +501,14 @@ public static class Help
|
||||||
text = dict[option];
|
text = dict[option];
|
||||||
else if (option == "all")
|
else if (option == "all")
|
||||||
text = $"{helpText}\n{string.Join('\n', dict.Values)}";
|
text = $"{helpText}\n{string.Join('\n', dict.Values)}";
|
||||||
|
else if (option == "help")
|
||||||
|
text = $"Choose from:\n\n {string.Join("\n ", dict.Keys)}";
|
||||||
else if (option != null)
|
else if (option != null)
|
||||||
Console.WriteLine($"Unrecognized help option '{option}'");
|
text = $"Unrecognized help option '{option}'. Choose from:\n\n {string.Join("\n ", dict.Keys)}";
|
||||||
|
|
||||||
var lines = text.Split('\n').Skip(1);
|
var lines = text.Split('\n').AsEnumerable();
|
||||||
|
if (lines.Any() && lines.First().Trim() == "")
|
||||||
|
lines = lines.Skip(1);
|
||||||
int minIndent = lines.Where(line => line.Trim().Length > 0).Min(line => line.TakeWhile(char.IsWhiteSpace).Count());
|
int minIndent = lines.Where(line => line.Trim().Length > 0).Min(line => line.TakeWhile(char.IsWhiteSpace).Count());
|
||||||
text = string.Join("\n", lines.Select(line => line.Length > minIndent ? line[minIndent..] : line));
|
text = string.Join("\n", lines.Select(line => line.Length > minIndent ? line[minIndent..] : line));
|
||||||
Console.WriteLine(text);
|
Console.WriteLine(text);
|
||||||
|
|
Loading…
Reference in a new issue