Commit graph

112 commits

Author SHA1 Message Date
Dominik Schrempf
e39dcfc002
clarify -a option for beet modify
See https://github.com/beetbox/beets/discussions/4172.

I think the confusion arises because the documentation refers to the
query. That is, when `-a` is given, albums are queried, not tracks. This
is especially clear when using `beet list`, because then it truly lists
"albums instead of items". However, for other commands, the distinction
between what is queried and what is acted on should be made more clear.

This PR fixes the section for `modify`, but there are more questions:

- `remove` command: The documentation states that it acts on albums
instead of individual tracks. I guess we should also amend that? I think
the complete album including the tracks is deleted, or is that not true?

- `move` command: I think the same is true for this command. If `-a` is
  given, the queried albums including all tracks are moved.

- `update` command: The `-a` flag is not explained here.
2021-12-03 22:36:48 +01:00
Pranesh Prakash
b33dbcdd40
Indicate update moves files by default 2021-10-13 19:01:49 +05:30
Adrian Sampson
a4352ff845
Merge branch 'master' into 7z_support 2021-05-08 09:47:51 -07:00
Andrew Rogl
a28099a351 Remove reference to rarfile version in link 2021-05-08 19:18:11 +10:00
Andrew Rogl
cff4ed59bf Update documentation 2021-05-08 15:33:58 +10:00
Jack Wilsdon
a9ba25439f
Add --plugins flag 2020-10-21 23:44:33 +01:00
wisp3rwind
822bc1ce88 add possibility to select individual items to the remove CLI command 2020-09-13 14:26:00 +02:00
ybnd
d3b759d7ca Fix list -af example in documentation
Didn't work since $tracktotal is not an Album field
2020-05-29 13:29:31 +02:00
Mat
e760fc6947
Wording/grammar 2019-12-16 21:47:13 +00:00
FichteFoll
9631616b53
Replace a couple URLs that don't point to anything
I'm unsure regarding the pygst tutorial, so I just added another URL
of the best resource I could find with a quick web search.
2019-06-05 23:08:18 +02:00
FichteFoll
aa31fea037
Update a lot of URLs to use HTTPS
*All* URLs were checked manually, but only once per domain!

I mostly concerned myself with URLs in documentation rather than source
code because the latter may or may not have impactful changes, while the
former should be straight forward.

Changes in addition to simply adding an s:

- changed pip and pypi references as their location has changed
- MPoD (iOS app) url redirects to Regelian, so I replaced those
- updated homebrew references

Notable observations:

- beets.io does have HTTPS set up properly (via gh-pages)
- beatport.py uses the old HTTP url for beatport
- as does lyrics.py for lyrics.wikia.com
- https://tomahawk-player.org/ expired long ago, but the http page
  redirects to https regardless
- none of the sourceforge subdomains have https (in 2019!)
2019-06-05 03:11:49 +02:00
Jack Wilsdon
bed3abd97a
Allow exiting object selection early 2018-11-28 17:17:12 +00:00
tummychow
e848adab04 Implement from_scratch option
Fixes #934, and also helps with #1173.
2017-12-07 14:46:40 -05:00
Adrian Sampson
71d6dc3544 Docs refinements for #2581 2017-06-13 09:27:42 -04:00
A.L. Kleijngeld
2eb4e3d515 Merge branch 'master' into master 2017-06-13 14:43:10 +02:00
Bart Kleijngeld
52d5d2310b refactoring according to feedback in pull request 2017-06-12 16:46:09 +02:00
Adrian Sampson
dfde9ce916 Merge pull request #2510 from SpirosChadoulos/master
New export command (issue #435)
2017-06-11 12:21:06 -04:00
Bart Kleijngeld
91722aea36 added documentation 2017-05-30 21:29:49 +02:00
SpirosChadoulos
3c852d3539 docs 2017-05-13 12:26:31 +03:00
Adrian Sampson
346ecbc6d4 Slightly more verbose config overlay description 2017-04-15 15:43:26 -04:00
Adrian Sampson
8e58a61eb4 Remove one blank line 2017-04-15 15:34:09 -04:00
MolarAmbiguity
a526eb7222 Implement feedback from sampsyo 2017-04-15 09:23:35 +10:00
MolarAmbiguity
94b75e8fb4 Fix bulleted list 2017-04-14 12:57:42 +10:00
MolarAmbiguity
ad87d2af92 Add info about overlaying configs 2017-04-14 12:40:32 +10:00
Adrian Sampson
af335868a8 Writing refinement for #2480
A slightly more nuanced description. Also use two separate paragraphs.
2017-03-18 14:10:21 -04:00
abigaildelarosa
bbd0b22005 change modify paragraph 2017-03-17 16:38:59 +01:00
karpinski
88d26e7694 Adding a move option to the importer's CLI and updating the docs. 2017-02-07 21:19:45 +01:00
Adrian Sampson
f31e6110e6 Simplify #2280 docs
I've backed out the FAQ entry, since the main docs seem like the right place
for this.
2016-11-24 23:59:00 -05:00
Adrian Sampson
d6b15f4eaa Remove duplicated line in docs (#2280)
For consistency: we don't show the aliases here for the other commands.
2016-11-24 23:51:10 -05:00
Peter Kessen
488225d837 Added documentation and FAQ for selective modify 2016-11-24 19:41:31 +01:00
Peter Kessen
9f48338291 Corrected docs for modify command
added short form ´mod´ and added switch ´-f´
2016-11-24 19:04:42 +01:00
Dang Mai
8d07bfe693 Documentation for new flag 2016-10-20 23:33:20 -04:00
Jack Wilsdon
0d2923e4ea Add documentation for beet remove --force 2016-06-08 19:26:19 +01:00
Dave Hayes
2f1dd9451b Add notes for installing the ZSH completion script 2016-04-25 13:04:05 -05:00
Peter Kessen
f6b81c1bdd Made changes suggested by @sampsyo 2016-02-04 18:35:01 +01:00
Peter Kessen
fac814421a Added documentation for changes by #1843 2016-02-04 17:59:59 +01:00
Adrian Sampson
d093ef9a47 A little more documentation for fields (#1818) 2016-01-28 13:52:07 -08:00
Diego Moreda
4f51302d09 Fix typo on importer search by id documentation 2016-01-22 19:48:22 +01:00
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