Commit graph

219 commits

Author SHA1 Message Date
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. This helps preserve
modularity/readability by avoiding contamination of the subcommand logic with
beets-specific logic.
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
Tai Lee
1d236aaa79 Add docs for none_rec_action setting. 2013-01-29 15:02:32 +11:00
Adrian Sampson
cc0e9112b4 document migration from 1.0 to 1.1 2013-01-24 16:55:00 -08:00
Adrian Sampson
9e6b1db02d configurable match thresholds (GC-290) 2013-01-11 14:46:15 -08:00
Adrian Sampson
c418e6d379 configurable MusicBrainz host/rate limit (GC-408) 2013-01-11 13:33:14 -08:00
Adrian Sampson
974929541f terminal_encoding config option (GC-472) 2013-01-11 13:07:57 -08:00
Adrian Sampson
b9a6f4d617 remove outdated "art" config in docs 2013-01-06 16:21:20 -08:00
Adrian Sampson
3e2aca82b8 correctly parse and migrate "pluginpath"
This used to be a colon-separated list. Now we use a real YAML list (or a
single string).
2012-12-31 16:09:16 -08:00
Adrian Sampson
11e1fd1bd8 document new Confit-based configuration 2012-12-20 21:56:47 -08:00
Adrian Sampson
128a881bb4 GH-69/GC-450: docs, changelog, simplification 2012-12-05 09:10:07 -08:00
Adrian Sampson
3952fbec62 docs & changelog for pervasive format config (#62)
This version of the (renamed) _print_obj function uses introspection to
determine whether we're printing an Album or an Item. It's like function
overloading for Python! 😁
2012-10-20 20:29:49 -07:00
Adrian Sampson
8a63a381b4 docs: for per_disc_numbering, change path formats 2012-08-03 17:37:14 -07:00
Adrian Sampson
11d4fb1abb move album art fetching to a plugin (fetchart) 2012-06-24 00:34:50 -07:00
Adrian Sampson
2b000c47a2 per_disc_numbering config option (GC-335) 2012-05-17 12:44:48 -07:00
Adrian Sampson
c1d28252be use section headings for config options
Previously, we were using a definition list. This way things are easier to link
to. It will also likely scale better as we add more config options.
2012-05-16 17:37:38 -07:00
Adrian Sampson
9979c5a826 separate config options for item and album formats
Extends GC-362 (GH-38) to use two different config options: one for albums and
one for items.
2012-05-16 17:01:14 -07:00
kraymer
81fc626ba7 Issue 362:Make the default template string for the list command configurable. 2012-05-17 00:48:55 +02:00
Adrian Sampson
a2c12dc78f -c CLI option overrides import_move config option 2012-05-03 17:19:28 -07:00
Adrian Sampson
c4f9b452da docs for %aunique (#190) 2012-04-29 14:52:03 -07:00
Adrian Sampson
7b7658fc43 doc clarification: effect of moving 2012-04-10 13:52:32 -07:00
Adrian Sampson
6b696c842f cleanup and docs for import_move (GH-26, GC-266)
- Copying and moving are mutually exclusive. Moving overrides copying so the
  user only has to add one line ("import_move: true") to disable copying and
  enable moving in its place.
- Deleting is only possible when copying.
- Deprecating the "delete" option (moving is almost always better).
- Removed command-line switch for moving. It's somewhat "unsafe", so this
  removes some potential for accidental irreversible changes.
- Changelog & thanks.
- Update docs to refer to import_move instead of import_delete as the
  correct solution for ending up with only one copy of the file.
2012-04-10 13:41:24 -07:00
Domen Kožar
1af4f86c17 support move action when importing 2012-04-05 01:14:17 +02:00
Adrian Sampson
ffa2402ff4 revamp default character substitutions
There's no longer a distinction between Unix and Windows substitutions. Enough
users reported problems with Windows-forbidden characters on Samba shares that
it seems appropriate to make all filenames Windows-safe, even on Unix. Users who
really want those additional characters (<>:"?*|\) can re-enable them via the
"replace" option. Nobody has complained about beets being *too* conservative.

This also adds sanitization of control characters, which is an all-around good
idea, and the substitution now runs in the Unicode (rather than byte) domain.
2012-04-03 14:22:38 -07:00
Adrian Sampson
c0c80cd576 docs typo: missing $ in path formats 2012-03-17 12:28:27 -07:00
Adrian Sampson
62cf26806c strip characters in replacement 2012-02-19 12:19:55 -08:00
Adrian Sampson
f4dc13161c document space replacement in .beetsconfig 2012-01-30 14:06:16 -08:00
Adrian Sampson
307560a6c9 ignore all .* files by default (#293) 2012-01-16 17:09:25 -08:00
Adrian Sampson
6a082234fb docs fixes regarding album types 2012-01-11 17:10:26 -08:00
Adrian Sampson
ca6df97ee9 explain shorthand query keys 2011-12-28 19:06:15 -08:00
Adrian Sampson
d73c133a53 query-conditioned path formats (#210)
Also, Library.path_formats is now a list of pairs instead of a dictionary. (I
would have used an OrderedDict, but that was added in 2.7.)
2011-12-28 19:01:13 -08:00
Adrian Sampson
b493bc7004 configurable pathname substitution (#115) 2011-12-19 18:37:35 -08:00
Adrian Sampson
3c99e54174 switch out string.Template with new template parser (#231) 2011-12-15 11:53:58 -08:00
Adrian Sampson
0252865f61 fix some discussion of path formatting 2011-12-15 11:49:22 -08:00
Adrian Sampson
8736d359c6 "timeout" config value (#261) 2011-12-04 18:46:35 -08:00
Adrian Sampson
1ba4d74a75 use better default paths on Windows (#241) 2011-11-27 23:33:11 -08:00
Adrian Sampson
70c0a90793 manpage-ify the reference docs (#258) 2011-11-23 23:43:51 -08:00
Adrian Sampson
5965b37f51 skip (configurable) clutter filenames when importing 2011-11-13 17:14:40 -08:00
Adrian Sampson
737eabdb8c translate reference pages from wiki 2011-09-16 17:08:10 -07:00
Adrian Sampson
18aff4db01 Sphinx documentation skeleton 2011-09-16 13:57:15 -07:00