Commit graph

270 commits

Author SHA1 Message Date
Diego Moreda
51bf6a1c9f Add documentation for NotQuery, cleanup
* Add changelog and query.rst documentation entries for the usage of negated
queries.
* Cleanup NotQuery class as suggested during code review (PEP conforming
docstring, clarification on empty clause match behaviour).
2015-11-20 18:06:22 +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
Adrian Sampson
d29cc7b2c0 Refine docs for #1586 2015-10-07 16:36:12 -07:00
Adrian Sampson
3b604c7ff9 Merge pull request #1586 from mried/RobustCaseSensitiveDetection
A robust way to check for a case sensitive file system
2015-10-07 15:43:38 -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
Malte Ried
5832e8730e Changed the documentation of the PathQueries to reflect the usage of the file system cas-sensitivity. 2015-09-11 20:38:53 +02: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
e360438977 Note about escaping regex arguments in shell
A la #1520.
2015-06-25 21:27:28 -07: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
Adrian Sampson
061f0f71bf Merge pull request #1466 from tomjaspers/move-pretend-option
Implement `--pretend` option for the move command
2015-05-20 21:41:15 -07:00
Scott Thomas
07e352143e File modification note in docs
I couldn't get beet update to read metadata changes - turns out that puddletag
doesn't touch the file modification time by default. It's a perfectly sensible
behaviour but I thought I'd add a note in the `beet update` section in case
anyone else has this problem.
2015-05-21 00:45:20 +01:00
Tom Jaspers
be484f2af0 Implement --pretend option for the move command
The method `show_path_changes` takes a list of tuples (source, destination)
that will be printed on either single / double line, as proposed in #1405.
2015-05-20 13:03:18 +02:00
Tom Jaspers
0302c44909 Docs & changelog for case insensitive sort 2015-04-18 10:27:56 +02:00
Adrian Sampson
6004da7c42 Expand changelog for "or" queries (#1423) 2015-04-16 19:34:20 -07:00
Adrian Sampson
bc698c3c0e Merge pull request #1423 from tomjaspers/or-query-operator
Use comma as "or" operator for queries
2015-04-16 19:25:24 -07:00
Tom Jaspers
c98835709f Query documentation to include "or" operator 2015-04-16 09:44:49 +02:00
Adrian Sampson
0c7823b4a5 Add zsh completion instructions (fix #1420) 2015-04-15 19:53:27 -07:00
Bruno Cauet
8a71935a95 Document path detection update 2015-03-30 13:18:35 +02:00
Adrian Sampson
c37561c74b Redact by default (#1376) 2015-03-29 14:26:16 -07:00
Adrian Sampson
37860bf2ef --redacted is now --redact
Seems more direct to me.
2015-03-27 22:44:32 -04:00
Tom Jaspers
ce78be3eb6 Config: add docs & tests for --redacted option 2015-03-26 12:49:54 +01:00
Bruno Cauet
679b0a586b Remove list_format_{album,item} sections from docs 2015-03-07 13:45:58 +01:00
Bruno Cauet
58b39f1000 Merge branch 'master' into subcommand-auto-format-path 2015-03-05 17:53:31 +01:00
Bruno Cauet
f14f47f059 Renamed list_format_* into format_* 2015-03-04 16:51:28 +01:00
Adrian Sampson
eec8d5d2be Doc rewording for #1330 2015-03-01 17:09:36 -08:00
Adrian Sampson
e14f28fdda Merge pull request #1330 from brunal/path-query-case-sensitivity
Fix path query case sensitivity

Conflicts:
	docs/changelog.rst
2015-03-01 17:01:45 -08:00
Adrian Sampson
c05dea123e Docs clarity for verbosity levels (#1320) 2015-02-17 17:12:42 -05:00
Bruno Cauet
83e34322e9 Update changelog & docs 2015-02-17 13:14:29 +01:00
Bruno Cauet
a014750e2d Update docs: mention multi-level logging
If you think what I wrote suck, it's because it does.
2015-02-10 17:29:02 +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
a892128996 Changelog and rewording for import --pretend
(#1162)
2014-12-23 09:10:28 -05:00
Malte Ried
af36d85ef8 Implemented a better solution for the pretend flag
Corrected the documentation (shortcut -e is not available any more)
2014-12-23 13:52:22 +01:00
Malte Ried
2db346388a Added option --pretend to only print the filenames of files to import without importing them 2014-12-21 15:56:56 +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
2343387a68 beet stats output clarification (#1052)
Explicitly say that size calculation is approximate.
2014-11-01 12:46:14 -07:00
Adrian Sampson
f88a960a63 Changelog for #984
[ci skip]
2014-09-28 11:50:05 -07: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
d572bde13b Tiny docs typos
Conflicts:
	docs/plugins/index.rst
2014-09-12 20:58:24 -07:00
Adrian Sampson
132fad847b Changelog for sorting (#823) 2014-08-22 15:02:50 -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
Harry Khanna
65c4ae627e Clarify the default behavior for the write subcommand 2014-08-19 14:06:41 -04:00
Harry Khanna
2ffd3e287f Add --always flag for write subcommand
Forces a write of tags to file even if the file's tags match the database.
This is useful to force plugins that respond to write (e.g., Scrub and Zero) to run on those tags.
This may also make the TODO comment in zero.py less important since creates a way to manually run the zero plugin on a file imported as-is.
2014-08-19 13:43:16 -04:00
Adrian Sampson
3771134716 Add zsh completion script by @vapniks (#862) 2014-08-13 21:54:43 -07:00
Stig Inge Lea Bjørnsen
64fc3539cd Correct the textual description of a date query
The the date query syntax `2008-12..2009-10-11` covers the interval [2008-12-01T00:00:00, 2009-10-12T00:00:00).
2014-08-14 00:44:19 +02: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
35994e4bbd Docs: remove reference to "beet write -a"
This flag doesn't really exist!
2014-07-12 10:56:24 -07:00
Adrian Sampson
38bf08a49e Move path entry in field list 2014-07-02 18:59:37 -07:00
r04r
f6b59cf7df Add $path to the list of available values in pathformat.rst 2014-07-03 03:30:34 +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
Pierre Rust
3426363775 Add documentation about sort specification. 2014-06-15 22:32:25 +02:00
Stig Inge Lea Bjørnsen
5d7c78c219 Minor correction in the documentation for date queries. 2014-05-15 20:06:25 +02:00
Adrian Sampson
06ab0ec2e2 Tiny wording tweaks for #754 2014-05-10 17:19:04 -07:00
Fabrice L.
befc9746d9 Update pathformat.rst
mention bucket function
2014-05-10 23:28:59 +02:00
Fabrice Laporte
1303f0a4df Merge branch 'doc_plugins_templ_funcs' of github.com:KraYmer/beets into doc_plugins_templ_funcs
Conflicts:
	docs/reference/pathformat.rst
2014-05-09 09:01:07 +02:00
Fabrice Laporte
c002e4599c Add text to new _templ_plugins section
Replace links to ‘writing-plugin’ by internal links to ‘templ_plugins’.
Add small paragraph at the end of _templ_plugins to mention ‘inline’
plugin and the ‘Writing Plugins’ page.
2014-05-09 08:59:22 +02:00
Fabrice L.
c5babea31f fix typo from copy/paste 2014-05-08 22:27:21 +02:00
Fabrice Laporte
d8008e145f Add section listing template functions/fields provided by plugins for path
formatting
2014-05-08 22:05:26 +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
d91960a8cf minor comment/doc tweaks for #690
The description of the import command was getting a bit unwieldy. Splitting up
the paragraph helped a little, but the docs could still use some love here.
2014-04-15 20:41:10 -07:00
Thomas Scholtes
63097650ff Add docs and changelog for archive import 2014-04-15 20:36:46 +02:00
sahandKashani
3d675b2339 bash completion documentation fix for GNU Bash-4.2
In GNU Bash-4.2, I have to put quotes around the eval statement for the shell to correctly interpret the output of the beet completion command.
2014-04-04 09:28:53 +02:00
Adrian Sampson
b683f239f0 some style tweaks for #638 2014-04-02 21:18:41 -07:00
Bruno Tournay
cd70e92b7f Modify command: ability to delete/reset an attribute (beet modify field!) 2014-04-01 22:38:33 +02:00
Adrian Sampson
810841ba5a a couple new extremely basic FAQs
These are also very common questions from new users.
2014-03-21 18:04:35 -07: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
c846ecd48d completion: mention shell startup time
according to @geigerzaehler's suggestion
2014-03-08 12:07:21 -08:00
Adrian Sampson
a6ca63d67c bash completion (#553): expand docs 2014-03-07 15:03:30 -08:00
Adrian Sampson
f71307f87e changelog for #570 2014-03-06 11:00:00 -08:00
Thomas Scholtes
8a5a2fcebf Merge branch 'completion'
Conflicts:
	beets/ui/commands.py
	docs/reference/cli.rst
2014-03-02 23:06:05 +01:00
Thomas Scholtes
44c843793b Add completion of plugin commands 2014-03-02 16:18:16 +01:00
Thomas Scholtes
25080bd59f Add documentation for completion command 2014-03-02 15:50:23 +01: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