Adrian Sampson
71d6dc3544
Docs refinements for #2581
2017-06-13 09:27:42 -04:00
Bart Kleijngeld
52d5d2310b
refactoring according to feedback in pull request
2017-06-12 16:46:09 +02:00
Bart Kleijngeld
91722aea36
added documentation
2017-05-30 21:29:49 +02:00
Matt Murch
e224621e83
Add default replace for - to _
...
Also updated changelog and docs.
Resolves : #549
2017-04-12 13:48:37 -04:00
Adrian Sampson
70ef6e7df8
Fix heading underline length
2017-03-27 23:23:23 -04:00
SpirosChadoulos
218968235e
small changes for the bell issue
2017-03-28 01:09:14 +03:00
SpirosChadoulos
c605a918c8
Added an if statement that allows the bell ring according to the user's configuration.
2017-03-27 20:49:28 +03:00
Adrian Sampson
d10bfa1af6
Changelog & thanks for #2445
2017-02-20 22:11:34 -05:00
Jacob Gillespie
4e77ef4484
Address review comments
2017-02-19 20:48:34 -06:00
Jacob Gillespie
1fd22604fb
Fix linter issues
2017-02-19 17:33:26 -06:00
Jacob Gillespie
b4efecb709
Add option to hardlink when importing
2017-02-19 15:56:13 -06:00
A.L. Kleijngeld
24027d1bf8
Update config.rst: see issue #2410
...
`When a match is above the *medium* recommendation threshold`
->
`When a match is below the *medium* recommendation threshold`
As discussed in issue #2410 , which is fixed by this edit.
2017-01-27 21:48:46 +01:00
diomekes
5ee89666b6
fix typo in config docs
2017-01-07 09:54:54 -05:00
Adrian Sampson
f621d7f4f1
Merge pull request #1992 from jackwilsdon/add-write-bpm
...
Add write option to bpm plugin
2017-01-01 23:09:41 -05:00
Adrian Sampson
8cb6ff3892
Simplify the example config
...
I never meant for people to copy and paste this example---it's redundant and
probably wrong---but lots of people do! Removing a few weird options makes the
example clearer, I think, and will result in less-strange initial configs for
people who do copy & paste.
2017-01-01 19:18:25 -05:00
Stefano Rivera
bcb1f8036a
Correct a typo
...
Spotted by lintian which runs spellchecks on man pages.
2016-08-29 16:29:32 -07:00
Dixon Xavier
80ca527f76
Fix typo in documentation
2016-06-19 13:20:54 +05:30
Dixon Xavier
fbcc8dbf1e
Update changelog and documentation
2016-06-19 12:54:27 +05:30
Adrian Sampson
a440e44abd
Proofread the changelog
2016-05-31 10:33:56 -07:00
Johnny Robeson
c1a168590c
add lost+found directory to default ignore list
2016-05-06 20:51:37 -04:00
Jack Wilsdon
2d5c68cec9
Remove write option from bpm and use import.write
2016-05-06 17:50:27 +01:00
Jack Wilsdon
38a3726b1b
Add documentation
2016-05-06 00:45:45 +01:00
Guilherme Danno
8c471581e0
Use the 'terminal_encoding' option for overriding the sys.stdin.encoding in some cases ( #1964 )
...
* Use the 'terminal_encoding' option for overriding the `sys.stdin.encoding` in some cases
* Add the documentation
2016-04-28 00:17:19 -03:00
Sven-Hendrik Haase
a942719ffc
Fix grammar
2016-02-03 20:38:29 +01:00
Adrian Sampson
98f48237f5
Tiny docs tweaks for #1708
2015-11-08 13:04:26 -08:00
Manfred Urban
95b80b37aa
Updated documentation
2015-11-08 17:04:36 +01:00
Adrian Sampson
80bfd186ae
Use should_write for modify, update, and mbsync
...
This should address the surprising situation in #1697 , where `import` went
fine but then `update` unexpectedly changed filenames.
2015-11-07 13:34:47 -08:00
Adrian Sampson
f4a617e641
Move color option in config example ( fix #1653 )
2015-10-19 13:44:52 -07:00
David Logie
bfc5a1b803
Add new `include` config option.
...
This new option allows users to provide a list of external config files
which will be evaluated when beets starts.
This is useful for keeping private settings (e.g. API keys) out of the
main configuration file.
2015-10-05 14:01:26 +01:00
Adrian Sampson
f8d9019d1b
Better explanation of threaded option
...
It was pointed out that the old wording was too worrisome.
2015-09-06 17:14:55 -07:00
Ben Boeckel
323f79ecdb
colors: support standard terminal colors
...
Fixes #1548 .
Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
2015-08-05 22:00:25 -04:00
Ben Ockmore
1f1e0f7240
Added warning message and paragraph about replacements/max length interaction in documentation.
2015-07-07 17:46:42 +01:00
Adrian Sampson
419a12a2f2
Further clarify docs for #1493
2015-06-02 19:54:16 -07:00
Adrian Sampson
bc9caa5845
Update docs for #1493/#1104
2015-06-02 19:38:30 -07:00
Rui Gonçalves
93c8f834f0
Add support for pregap tracks
2015-06-03 00:54:25 +01:00
Adrian Sampson
7f5c274c46
Grouped-album tasks have paths
...
Close #1475 , fix #825 .
2015-05-25 12:57:23 -07:00
Tom Jaspers
0302c44909
Docs & changelog for case insensitive sort
2015-04-18 10:27:56 +02:00
Bruno Cauet
679b0a586b
Remove list_format_{album,item} sections from docs
2015-03-07 13:45:58 +01:00
Bruno Cauet
f14f47f059
Renamed list_format_* into format_*
2015-03-04 16:51:28 +01:00
Tom Jaspers
ea687baebd
Configurable colors: update documentation and changelog
2015-01-29 14:05:00 +01:00
Frederik “Freso” S. Olesen
ad00c5dc7b
docs: Fix hyperlink targets.
...
I inserted musicbrainz.searchlimit at the wrong place, breaking the
hyperlink target `match-config` - and I also forgot to add a hyperlink
target for `searchlimit`.
2015-01-19 02:24:32 +01:00
Frederik “Freso” S. Olesen
7c429e8c58
docs: New entry for musicbrainz.searchlimit config option.
2015-01-19 02:19:43 +01:00
Adrian Sampson
a197a12c3a
Mention #130 in docs
2014-12-15 04:36:01 +00:00
Adrian Sampson
c6af552703
docs: item_linked event ( #710 )
2014-11-15 12:21:14 -08:00
Adrian Sampson
1eebb6af3c
Docs for link option ( #710 )
2014-11-15 12:07:49 -08:00
Adrian Sampson
5f2ca0b75b
Rename smartartist to artist/albumartist ( #953 )
...
This is basically always what you want, so now you can just use the name of
the field without "smart".
2014-09-16 14:53:16 -07:00
Adrian Sampson
eb579cf14b
Merge pull request #823 from PierreRust/sortquery
...
Sorting support in beets query mecanism (dbcore)
2014-08-22 14:59:44 -07:00
Adrian Sampson
d5910b4e85
Docs tweaks
2014-08-10 16:20:17 -07:00
Thomas Scholtes
f1388eb23d
docs: Add note for 'replace' config and unicode
2014-08-06 18:00:18 +02:00
Thomas Scholtes
76c7ba9186
Add asciify_paths configuration option
2014-08-06 17:53:44 +02:00
Adrian Sampson
b6582e417f
Changelog and doc fixes for #852
2014-07-02 14:51:41 -07:00
oprietop
8a4c668218
Documenting #852
2014-07-02 09:27:58 +02:00
Adrian Sampson
16f6a3daa7
Note about group-albums and import log ( #825 )
2014-06-25 10:05:31 -07:00
Pierre Rust
486289b11a
Add documentation about default sort configuration.
2014-06-15 22:32:25 +02:00
Adrian Sampson
9101b88499
Slightly shorter description of autotag
...
Brevity is the soul of documentation.
2014-04-29 21:57:39 -07:00
Evan Purkhiser
63fc7e04e6
docs: Document 'import.autotag' configuration
2014-04-30 00:14:49 -04:00
Adrian Sampson
882d2305c0
docs: emphasize that you create config.yaml
...
This is, shockingly, the #1 question I get asked. I hope this helps.
2014-03-21 17:55:18 -07:00
Adrian Sampson
b0fd64662d
update docs for #619
2014-03-19 10:34:03 -07:00
Adrian Sampson
f71307f87e
changelog for #570
2014-03-06 11:00:00 -08:00
Adrian Sampson
692645466e
documentation expansion for config command ( #552 )
2014-02-28 09:31:10 -08:00
Thomas Scholtes
c345df9155
Merge branch 'config_command'
...
Conflicts:
beets/ui/commands.py
docs/reference/config.rst
test/_common.py
2014-02-28 16:50:06 +01:00
Adrian Sampson
8ddf04e711
refine config location discussion ( #513 )
2014-02-21 21:22:55 -05:00
Adrian Sampson
622ca2b244
Unixy location is fallback on OS X
...
This is mainly for backwards compatibility. It's also an effort to reduce the
support burden; this way, I can say "your config directory is ~/.config/beets"
without needing to ascertain whether someone is on a Mac.
2014-02-21 20:57:06 -05:00
Thomas Scholtes
575dc9d0c1
Documentation for config command
2014-02-18 21:29:31 +01:00
Thomas Scholtes
d0e5b411cf
Documentation for configuration location
2014-02-18 18:24:49 +01:00
Adrian Sampson
5d55312fdb
add TOCs to some documentation
2014-02-16 19:25:26 -08:00
Adrian Sampson
276a09bad7
clean up --config handling
...
In reference to a363d9672f
2014-02-13 13:46:20 -08:00
Thomas Scholtes
ba226f566d
Update docs for fix a363d967
2014-02-10 17:29:23 +01:00
Adrian Sampson
5e2f7d6fcc
remove some anachronisms from the docs
2014-02-07 19:55:07 -08:00
Adrian Sampson
aaeb166608
a bit more documentation for --config
2014-02-02 13:48:21 -08:00
Adrian Sampson
8b87fff3e3
a bit more documentation for --group-albums ( #518 )
2014-02-01 12:52:16 -08:00
Thomas Scholtes
d75f6667e1
Add --config cli option
2014-01-29 23:38:05 +01:00
Thomas Scholtes
a4b6976755
Make plugin path configuration useable
2014-01-20 17:39:46 +01:00
Adrian Sampson
f239489549
docs: remove outdated path_format config option
...
The example config contained a configuration key that's been unsupported for
years! How embarrassing.
2014-01-10 19:12:45 -08:00
Adrian Sampson
c0c01b2680
id3v23 config option ( fix #388 )
2013-10-06 20:20:18 -07:00
Adrian Sampson
ddf5c4ce54
integrate FAQ links with the rest of the docs
2013-09-16 19:26:09 -07:00
Adrian Sampson
4f1ce5a64c
docs: mention musicbrainz port config ( closes #365 )
2013-09-12 11:11:04 -07:00
Adrian Sampson
b1ea90a724
don't duplicate penalty names in max_rec section
...
This is for maintanability: in the future, when we add new distance penalty
components, now we won't have to list them twice in the default config.
2013-06-10 15:59:41 -07:00
Adrian Sampson
82991ce614
documentation enhancements for new config opts
2013-06-10 15:53:06 -07:00
Tai Lee
f3545860da
Add ignored setting. Don't show matches with specified penalties applied, e.g. missing tracks or unmatched tracks.
...
If you know you never want these, they can clutter up the interface
especially now that we have multiple data sources.
2013-06-03 00:35:32 +10:00
Tai Lee
45dc99f1a9
Group preferred media patterns, in case they contain "|" to keep them separate from the number of media.
2013-06-03 00:25:31 +10:00
Tai Lee
e6ac8e1646
Use a Distance object instead of floats for distance calculations.
...
The new Distance object knows how to perform various types of distance
calculations (expression, equality, number, priority, string).
It will keep track of each individual penalty that has been applied so
that we can utilise that information in the UI and when making decisions
about the recommendation level.
We now display the top 3 penalties (sorted by weight) on the release
list (and "..." if there are more than 3), and we display all penalties
on the album info line and track change line.
The implementation of the `max_rec` setting has been simplified by
removing duplicate validation and instead looking at the penalties that
have been applied to a distance. As a result, we can now configure a
maximum recommendation for any penalty that might be applied.
We have a few new checks when calculating album distance:
`match: preferred: countries` and `match: preferred: media` can each be
set to a list of countries and media in order of your preference. These
are empty by default. A value that matches the first item will have no
penalty, and a value that doesn't match any item will have an unweighted
penalty of 1.0.
If `match: preferred: original_year` is set to "yes", beets will apply
an unweighted penalty of 1.0 for each year of difference between the
release year and the original year.
We now configure individual weights for `mediums` (disctotal), `label`,
`catalognum`, `country` and `albumdisambig` instead of a single generic
`minor` weight. This gives more control, but more importantly separates
and names the applied penalties so that the UI can convey exactly which
fields have contributed to the overall distance penalty.
Likewise, `missing tracks` and `unmatched tracks` are penalised and
displayed in the UI separately, instead of a combined `partial` penalty.
Display non-MusicBrainz source in the disambiguation string, and
"source" in the list of penalties if a release is penalised for being
a non-MusicBrainz.
2013-06-02 18:25:10 +10:00
Adrian Sampson
b3646f2659
fix some docs syntax
2013-05-28 21:28:26 -07:00
Tai Lee
a5151bb32e
Look at many more metadata fields when calculating distance.
...
Produce slightly more varied similarity score to prioritise extremely
similar releases.
2013-05-29 10:18:55 +10:00
Tai Lee
e66a865f17
Rename the discogs max rec setting to non_mb_source, so it can apply to all data source plugins.
2013-05-25 22:44:41 +10:00
Tai Lee
f5557a74d7
Update intersecting max_rec and discogs docs.
2013-05-24 15:01:19 +10:00
Adrian Sampson
706c4fb7f6
import.detail config option (GC-263)
2013-02-26 20:36:29 -08:00
Adrian Sampson
0045880f58
change option name to "languages"; docs ( #102 )
2013-02-26 14:38:34 -08:00
Adrian Sampson
fa9d326d39
ignore "System Volume Information" directory
...
This is a control directory on Windows whose permissions are always set very
restrictively:
http://blogs.msdn.com/b/oldnewthing/archive/2003/11/20/55764.aspx
2013-02-24 15:53:47 -08:00
Adrian Sampson
3e624ea884
original_date config option (GC-441)
2013-02-08 13:45:31 -08:00
Adrian Sampson
15a652ab73
docs/changelog: filename length detection (GC-461)
2013-02-08 12:57:31 -08:00
Adrian Sampson
fa4d8d96e7
max_rec ( #98 ): more lenient defaults
...
These defaults more closely reflect the current behavior of beets, which I
think is desirable.
2013-02-07 23:39:13 -08:00
Adrian Sampson
7a4c228c79
style tweaks & doc expansion ( #98 )
2013-02-07 23:35:27 -08:00
Tai Lee
baa5bc5a01
Add max_rec configuration options.
...
Allow users to apply a maximum recommendation to partial albums and albums
with differing track lengths/numbers.
2013-02-08 17:42:00 +11:00
Adrian Sampson
d544c832c7
changelog, docs, and style tweaks for #93
2013-02-04 22:44:04 -08:00
Adrian Sampson
2ea190ceba
better error message when using real tabs
2013-02-02 10:37:02 -08:00
Adrian Sampson
bba0051ee7
changelog & doc tweaks for smartplaylist ( #80 )
2013-01-31 10:07:18 -08:00
Adrian Sampson
521a4d1ebd
Merge pull request #77 from mrmachine/none-rec-action
...
For matches with no recommendation, import as-is or skip automatically.
2013-01-30 20:38:12 -08:00
Adrian Sampson
ee641e9b13
default_action config option, et cetera ( #76 )
...
- Partial matches are always downgraded to a "medium" match.
- The config option, now called "default_action", lets you choose what to do
with "medium" matches.
- Expanded the "low" recommendation level to include cases with just one
match.
2013-01-30 20:32:37 -08:00
Tai Lee
6286954435
Add docs for confirm_partial setting.
2013-01-29 15:04:01 +11:00
