Commit graph

124 commits

Author SHA1 Message Date
Diego Moreda
79d84c0e4f Style and doc fixes for MB_id importer argument
* Rename the importer argument and related variables to make it more
generic, as the feature should be independent of the backend used and
not restricted to MusicBrainz.
* Update documentation and docstrings accordingly.
* Add changelog entry.
2016-01-22 16:31:00 +01:00
Diego Moreda
b526227482 Cleanup and documentation for MB_id importer arg
* Style cleanup and fixes for the "--musicbrainzid" import argument.
* Allow the input of several IDs (separated by spaces) on the "enter Id"
importer prompt.
* Add basic documentation.
2016-01-21 17:08:53 +01:00
Adrian Sampson
c7045daf90 sampsyo -> beetbox (#1730) 🎉 2016-01-08 20:36:16 -08:00
François-Xavier Thomas
50789e88fe Fix 1583: Move command only shows modified files 2016-01-01 17:49:53 +01: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
Adrian Sampson
0c7823b4a5 Add zsh completion instructions (fix #1420) 2015-04-15 19:53:27 -07: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
Adrian Sampson
c05dea123e Docs clarity for verbosity levels (#1320) 2015-02-17 17:12:42 -05: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
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
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
d572bde13b Tiny docs typos
Conflicts:
	docs/plugins/index.rst
2014-09-12 20:58:24 -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
Adrian Sampson
35994e4bbd Docs: remove reference to "beet write -a"
This flag doesn't really exist!
2014-07-12 10:56:24 -07:00
Pierre Rust
3426363775 Add documentation about sort specification. 2014-06-15 22:32:25 +02: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
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
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
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
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
Adrian Sampson
f98dde1b7e docs/changelog for write (#328, #448) 2013-11-25 15:34:11 -08:00
Wieland Hoffmann
39d67363b5 ref/cli.rst: Remove a 'd' 2013-08-06 10:40:17 +02:00
Wieland Hoffmann
e0ea009508 ref/cli.rst: Add a missing 'k' 2013-08-06 10:40:17 +02:00
Wieland Hoffmann
cc3d12f218 docs/.../cli.rst: Add an of to the description of update -p
This seems to have been missed when the documentation was added in the first place.
2013-07-12 19:11:47 +02:00
Adrian Sampson
58bd8a9e24 docs: a note about albums and the update command 2013-06-15 22:49:14 -07:00
Adrian Sampson
45baa6efe1 first stab at "advanced guide" 2013-05-19 17:35:23 -07:00
Adrian Sampson
916ceb4b15 changelog and tweaks for #275
I've removed the -p option. The command now always shows plugin-provided
template fields if any are available. We also avoid printing out blank lines
for plugins that don't provide fields.
2013-05-17 11:55:17 -07:00
Pedro Silva
4f5faeccac Append plugin template fields to 'beet fields' output with -p, --plugins 2013-05-15 13:41:54 +01:00
Adrian Sampson
5f3ebde6bb mbsync: docs/changelog
As discussed on #115, this has the "reimport" docs refer to the mbsync plugin.
2013-03-03 16:41:48 -08:00
Adrian Sampson
f268aae17f add --flat option to import command (GC-202) 2013-02-26 20:59:52 -08:00
Adrian Sampson
11e1fd1bd8 document new Confit-based configuration 2012-12-20 21:56:47 -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
244ffd71e2 fix "beet modify" for date fields (GC-449)
This is fixed by allowing MediaFiles to convert strings to integers on
assignment. An eventual complete fix will perform these type conversions in the
Item interface.
2012-10-14 20:27:13 -07:00
Adrian Sampson
cb93900888 changelog & docs for "beet stats --exact" 2012-10-07 15:13:49 -07:00
Adrian Sampson
1372e42dec docs: warn that incremental must be enabled early 2012-09-30 14:16:30 -07:00
Adrian Sampson
1f5ae6600b warning when using unrecognized fields in queries 2012-07-25 15:41:22 -07:00
Adrian Sampson
11d4fb1abb move album art fetching to a plugin (fetchart) 2012-06-24 00:34:50 -07:00
Petr Viktorin
d3c8297527 Add missing parenthesis in docs 2012-06-17 20:26:26 +03:00
Fabrice Laporte
16d9b53168 Update docs/reference/cli.rst: add -f option to beet list command 2012-05-13 23:52:27 +03:00
Adrian Sampson
e017a95154 docs: clarify single-quote comment is for Unix 2012-04-19 10:24:30 -07:00
Adrian Sampson
a64dea25b2 docs for @djrtl's changes (#30) 2012-04-15 14:24:52 -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
Adrian Sampson
1b1b8c4ae3 cleanup/docs for list formatting (#203; #22 on GH) 2012-03-14 14:51:13 -07:00
Adrian Sampson
2ff4fe5ccd remove erroneous reference to -d flag (#314) 2012-01-29 13:44:06 -08:00
Adrian Sampson
7a189b2135 document global CLI flags 2011-12-17 22:00:33 -08:00
Adrian Sampson
70c0a90793 manpage-ify the reference docs (#258) 2011-11-23 23:43:51 -08:00
Adrian Sampson
4b5c674d9b "--pretend" (dry run) flag for update 2011-09-18 16:18:19 -07:00
Adrian Sampson
e013745f1c introductory paragraphs 2011-09-17 16:02:06 -07:00
Adrian Sampson
521131bc2b screenshot image and syntax cleanup 2011-09-17 15:32:27 -07:00
Adrian Sampson
4e6798b2a6 convert getting started guide
--HG--
rename : docs/starting/index.rst => docs/guides/index.rst
rename : docs/starting/main.rst => docs/guides/main.rst
rename : docs/starting/tagger.rst => docs/guides/tagger.rst
2011-09-16 17:40:22 -07: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