Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
BEETSCONFIG(5)			     beets			BEETSCONFIG(5)

NAME
       beetsconfig - beets configuration file

       Beets  has  an  extensive  configuration	system that lets you customize
       nearly every aspect of its operation. To	configure beets, you create  a
       file  called config.yaml. The location of the file depend on your plat-
       form (type beet config -p to see	the path on your system):

       o On Unix-like OSes, write ~/.config/beets/config.yaml.

       o On Windows, use %APPDATA%\beets\config.yaml. This is usually in a di-
	 rectory like C:\Users\You\AppData\Roaming.

       o On  OS	 X, you	can use	either the Unix	location or ~/Library/Applica-
	 tion Support/beets/config.yaml.

       You can launch your text	editor to create or update your	 configuration
       by  typing beet config -e. (See the config-cmd command for details.) It
       is also possible	to customize the location of  the  configuration  file
       and  even use multiple layers of	configuration. See Configuration Loca-
       tion, below.

       The config file uses YAML syntax. You can use the full power  of	 YAML,
       but  most  configuration	options	are simple key/value pairs. This means
       your config file	will look like this:

	  option: value
	  another_option: foo
	  bigger_option:
	      key: value
	      foo: bar

       In YAML,	you will need to use spaces (not tabs!)	to indent some	lines.
       If  you	have questions about more sophisticated	syntax,	take a look at
       the YAML	documentation.

       The rest	of this	page enumerates	the dizzying litany  of	 configuration
       options available in beets. You might also want to see an example.

       o Global	Options

	 o library

	 o directory

	 o plugins

	 o include

	 o pluginpath

	 o ignore

	 o ignore_hidden

	 o replace

	 o asciify_paths

	 o art_filename

	 o threaded

	 o format_item

	 o format_album

	 o sort_item

	 o sort_album

	 o sort_case_insensitive

	 o original_date

	 o artist_credit

	 o per_disc_numbering

	 o aunique

	 o terminal_encoding

	 o clutter

	 o max_filename_length

	 o id3v23

	 o va_name

       o UI Options

	 o color

	 o colors

       o Importer Options

	 o write

	 o copy

	 o move

	 o link

	 o hardlink

	 o resume

	 o incremental

	 o incremental_skip_later

	 o from_scratch

	 o quiet_fallback

	 o none_rec_action

	 o timid

	 o log

	 o default_action

	 o languages

	 o detail

	 o group_albums

	 o autotag

	 o duplicate_action

	 o bell

	 o set_fields

       o MusicBrainz Options

	 o searchlimit

       o Autotagger Matching Options

	 o max_rec

	 o preferred

	 o ignored

	 o required

	 o ignored_media

	 o ignore_data_tracks

	 o ignore_video_tracks

       o Path Format Configuration

       o Configuration Location

	 o Environment Variable

	 o Command-Line	Option

	 o Default Location

       o Example

GLOBAL OPTIONS
       These options control beetsa global operation.

   library
       Path  to	 the  beets  library  file.  By	default, beets will use	a file
       called library.db alongside your	configuration file.

   directory
       The directory to	which files will be copied/moved when adding  them  to
       the library. Defaults to	a folder called	Music in your home directory.

   plugins
       A  space-separated list of plugin module	names to load. See using-plug-
       ins.

   include
       A space-separated list of extra configuration files to include.	 File-
       names are relative to the directory containing config.yaml.

   pluginpath
       Directories  to search for plugins.  Each Python	file or	directory in a
       plugin path represents a	plugin and should define a subclass  of	 Beet-
       sPlugin.	  A  plugin  can  then be loaded by adding the filename	to the
       plugins configuration.  The plugin path can either be a	single	string
       or  a  list of stringsaso, if you have multiple paths, format them as a
       YAML list like so:

	  pluginpath:
	      -	/path/one
	      -	/path/two

   ignore
       A list of glob patterns specifying file and directory names to  be  ig-
       nored  when  importing.	By  default, this consists of .*,  *~,	System
       Volume Information, lost+found (i.e., beets ignores  Unix-style	hidden
       files,  backup  files, and directories that appears at the root of some
       Linux and Windows filesystems).

   ignore_hidden
       Either yes or no; whether to ignore hidden  files  when	importing.  On
       Windows,	 the  aHiddena	property of files is used to detect whether or
       not a file is hidden. On	OS X, the fileas aIsHiddena flag  is  used  to
       detect  whether	or  not	a file is hidden. On both OS X and other plat-
       forms (excluding	Windows), files	(and directories) starting with	a  dot
       are detected as hidden files.

   replace
       A  set  of  regular  expression/replacement  pairs to be	applied	to all
       filenames created by beets. Typically, these replacements are  used  to
       avoid  confusing	 problems  or errors with the filesystem (for example,
       leading dots, which hide	files on Unix, and trailing whitespace,	 which
       is illegal on Windows). To override these substitutions,	specify	a map-
       ping from regular expression to replacement strings. For	example, [xy]:
       z  will	make beets replace all instances of the	characters x or	y with
       the character z.

       If you do change	this value, be	certain	 that  you  include  at	 least
       enough  substitutions to	avoid causing errors on	your operating system.
       Here are	the default substitutions used by beets, which are  sufficient
       to avoid	unexpected behavior on all popular platforms:

	  replace:
	      '[\\/]': _
	      '^\.': _
	      '[\x00-\x1f]': _
	      '[<>:"\?\*\|]': _
	      '\.$': _
	      '\s+$': ''
	      '^\s+': ''
	      '^-': _

       These  substitutions remove forward and back slashes, leading dots, and
       control charactersaall of which is a good idea on any  OS.  The	fourth
       line removes the	Windows	areserved charactersa (useful even on Unix for
       for compatibility  with	Windows-influenced  network  filesystems  like
       Samba).	 Trailing  dots	and trailing whitespace, which can cause prob-
       lems on Windows clients,	are also removed.

       When replacements other than the	defaults are used, it is possible that
       they  will  increase the	length of the path. In the scenario where this
       leads to	a conflict with	the maximum filename length, the  default  re-
       placements  will	be used	to resolve the conflict	and beets will display
       a warning.

       Note that paths might contain special characters	such as	 typographical
       quotes  (^a^a).  With the configuration above, those will not be replaced
       as they donat match the typewriter quote	("). To	also strip these  spe-
       cial characters,	you can	either add them	to the replacement list	or use
       the asciify_paths configuration option below.

   asciify_paths
       Convert all non-ASCII characters	in paths to ASCII equivalents.

       For example, if your path template for singletons is  singletons/$title
       and  the	title of a track is aCafA(C)a, then the	track will be saved as
       singletons/Cafe.mp3.   The  changes  take  place	 before	 applying  the
       replace	configuration  and are roughly equivalent to wrapping all your
       path templates in the %asciify{}	template function.

       Default:	no.

   art_filename
       When importing album art, the name  of  the  file  (without  extension)
       where  the cover	art image should be placed. This is a template string,
       so you can use any of the syntax	 available  to	/reference/pathformat.
       Defaults	 to  cover  (i.e., images will be named	cover.jpg or cover.png
       and placed in the albumas directory).

   threaded
       Either yes or no, indicating whether the	autotagger should use multiple
       threads.	 This  makes  things substantially faster by overlapping work:
       for example, it can copy	files for one album in parallel	 with  looking
       up  data	 in MusicBrainz	for a different	album. You may want to disable
       this when debugging problems with the autotagger.  Defaults to yes.

   format_item
       Format to use when listing individual items with	the  list-cmd  command
       and  other commands that	need to	print out items. Defaults to $artist -
       $album -	$title.	The -f command-line option overrides this setting.

       It used to be named list_format_item.

   format_album
       Format to use when listing albums with list-cmd and other commands. De-
       faults  to  $albumartist	- $album. The -f command-line option overrides
       this setting.

       It used to be named list_format_album.

   sort_item
       Default sort order to use when fetching items from  the	database.  De-
       faults  to  artist+  album+ disc+ track+. Explicit sort orders override
       this default.

   sort_album
       Default sort order to use when fetching albums from the	database.  De-
       faults  to  albumartist+	album+.	Explicit sort orders override this de-
       fault.

   sort_case_insensitive
       Either yes or no, indicating whether the	case should  be	 ignored  when
       sorting lexicographic fields. When set to no, lower-case	values will be
       placed after upper-case values (e.g., Bar Qux foo), while yes would re-
       sult in the more	expected Bar foo Qux. Default: yes.

   original_date
       Either  yes  or no, indicating whether matched albums should have their
       year, month, and	day fields set to the release  date  of	 the  original
       version	of  an	album rather than the selected version of the release.
       That is,	if this	option is turned on, then year will always equal orig-
       inal_year and so	on. Default: no.

   artist_credit
       Either  yes  or no, indicating whether matched tracks and albums	should
       use the artist credit, rather than the artist. That is, if this	option
       is  turned  on,	then artist will contain the artist as credited	on the
       release.

   per_disc_numbering
       A boolean controlling the track numbering style on multi-disc releases.
       By  default  (per_disc_numbering: no), tracks are numbered per-release,
       so the first track on the second	disc has track number N+1 where	 N  is
       the  number  of tracks on the first disc. If this per_disc_numbering is
       enabled,	then the first (non-pregap) track  on  each  disc  always  has
       track number 1.

       If  you	enable per_disc_numbering, you will likely want	to change your
       Path Format Configuration also to include $disc before $track  to  make
       filenames  sort	correctly in album directories.	For example, you might
       want to use a path format like this:

	  paths:
	      default: $albumartist/$album%aunique{}/$disc-$track $title

       When this option	is off (the default), even apregapa hidden tracks  are
       numbered	 from  one,  not zero, so other	track numbers may appear to be
       bumped up by one. When it is on,	the pregap track for each disc can  be
       numbered	zero.

   aunique
       These  options  are  used to generate a string that is guaranteed to be
       unique among all	albums in the library who share	the same set of	keys.

       The defaults look like this:

	  aunique:
	      keys: albumartist	album
	      disambiguators: albumtype	year label catalognum albumdisambig releasegroupdisambig
	      bracket: '[]'

       See aunique for more details.

   terminal_encoding
       The text	encoding, as known to Python, to use for messages  printed  to
       the  standard output. Itas also used to read messages from the standard
       input.  By default, this	is determined automatically  from  the	locale
       environment variables.

   clutter
       When beets imports all the files	in a directory,	it tries to remove the
       directory if itas empty.	A directory is considered  empty  if  it  only
       contains	 files	whose  names match the glob patterns in	clutter, which
       should be a list	of strings. The	default	list consists  of  aThumbs.DBa
       and a.DS_Storea.

       The  importer  only  removes  recursively  searched  subdirectoriesathe
       top-level directory you specify on the command line is never deleted.

   max_filename_length
       Set the maximum number of characters in a filename, after  which	 names
       will  be	 truncated.  By	default, beets tries to	ask the	filesystem for
       the correct maximum.

   id3v23
       By default, beets writes	MP3 tags using the ID3v2.4 standard, the  lat-
       est version of ID3. Enable this option to instead use the older ID3v2.3
       standard, which is preferred by certain older software such as  Windows
       Media Player.

   va_name
       Sets the	albumartist for	various-artist compilations. Defaults to 'Var-
       ious Artists' (the MusicBrainz standard). Affects other	sources,  such
       as /plugins/discogs, too.

UI OPTIONS
       The  options  that  allow for customization of the visual appearance of
       the console interface.

       These options are available in this section:

   color
       Either yes or no; whether to use	color  in  console  output  (currently
       only  in	 the  import  command).	Turn this off if your terminal doesnat
       support ANSI colors.

       NOTE:
	  The color option was previously a top-level configuration.  This  is
	  still	 respected, but	a deprecation message will be shown until your
	  top-level color configuration	has been nested	under ui.

   colors
       The colors that are used	throughout the user interface. These are  only
       used  if	 the color option is set to yes. For example, you might	have a
       section in your configuration file that looks like this:

	  ui:
	      color: yes
	      colors:
		  text_success:	green
		  text_warning:	yellow
		  text_error: red
		  text_highlight: red
		  text_highlight_minor:	lightgray
		  action_default: turquoise
		  action: blue

       Available colors: black,	darkred, darkgreen, brown (darkyellow),	 dark-
       blue,  purple (darkmagenta), teal (darkcyan), lightgray,	darkgray, red,
       green, yellow, blue, fuchsia (magenta), turquoise (cyan), white

IMPORTER OPTIONS
       The options that	control	the import-cmd command are indented under  the
       import:	key.  For example, you might have a section in your configura-
       tion file that looks like this:

	  import:
	      write: yes
	      copy: yes
	      resume: no

       These options are available in this section:

   write
       Either yes or no, controlling whether metadata  (e.g.,  ID3)  tags  are
       written to files	when using beet	import.	Defaults to yes. The -w	and -W
       command-line options override this setting.

   copy
       Either yes or no, indicating whether to copy files into the library di-
       rectory	when  using  beet  import. Defaults to yes.  Can be overridden
       with the	-c and -C command-line options.

       The option is ignored if	move is	enabled	(i.e., beets can move or  copy
       files but it doesnat make sense to do both).

   move
       Either yes or no, indicating whether to move files into the library di-
       rectory when using beet import.	Defaults to no.

       The effect is similar to	the copy option	but you	end up with  only  one
       copy  of	the imported file. (aMovinga works even	across filesystems; if
       necessary, beets	will copy and then delete when a simple	rename is  im-
       possible.)  Moving files	can be riskyaitas a good idea to keep a	backup
       in case beets doesnat do	what you expect	with your files.

       This option overrides copy, so enabling it will always  move  (and  not
       copy)  files.  The -c switch to the beet	import command,	however, still
       takes precedence.

   link
       Either yes or no, indicating whether to use symbolic links  instead  of
       moving or copying files.	(It conflicts with the move, copy and hardlink
       options.) Defaults to no.

       This option only	works on platforms that	support	symbolic links:	 i.e.,
       Unixes.	It will	fail on	Windows.

       Itas  likely  that  youall also want to set write to no if you use this
       option to preserve the metadata on the linked files.

   hardlink
       Either yes or no, indicating whether to use hard	links instead of  mov-
       ing  or copying or symlinking files. (It	conflicts with the move, copy,
       and link	options.) Defaults to no.

       As with symbolic	links (see link, above), this will not work on Windows
       and you will want to set	write to no.  Otherwise, metadata on the orig-
       inal file will be modified.

   resume
       Either yes, no, or ask. Controls	whether	interrupted imports should  be
       resumed.	 aYesa	means  that  imports are always	resumed	when possible;
       anoa means resuming is disabled entirely;  aaska	 (the  default)	 means
       that  the user should be	prompted when resuming is possible. The	-p and
       -P flags	correspond to the ayesa	and anoa settings  and	override  this
       option.

   incremental
       Either yes or no, controlling whether imported directories are recorded
       and whether these recorded directories are skipped.   This  corresponds
       to the -i flag to beet import.

   incremental_skip_later
       Either  yes or no, controlling whether skipped directories are recorded
       in the incremental list.	When set to yes, skipped directories  will  be
       recorded,  and skipped later. When set to no, skipped directories wonat
       be recorded, and	beets will try to import them again later. Defaults to
       no.

   from_scratch
       Either  yes  or	no (default), controlling whether existing metadata is
       discarded  when	a  match  is  applied.	 This	corresponds   to   the
       --from_scratch flag to beet import.

   quiet_fallback
       Either  skip  (default) or asis,	specifying what	should happen in quiet
       mode (see the -q	flag to	import,	above) when there is no	strong	recom-
       mendation.

   none_rec_action
       Either ask (default), asis or skip. Specifies what should happen	during
       an interactive import session when there	is no  recommendation.	Useful
       when  you are only interested in	processing medium and strong recommen-
       dations interactively.

   timid
       Either yes or no, controlling whether the importer runs in timid	 mode,
       in  which it asks for confirmation on every autotagging match, even the
       ones that seem very close. Defaults to no.  The	-t  command-line  flag
       controls	the same setting.

   log
       Specifies  a  filename where the	importeras log should be kept.	By de-
       fault, no log is	written. This can be overridden	with the  -l  flag  to
       import.

   default_action
       One  of	apply,	skip, asis, or none, indicating	which option should be
       the default when	selecting an action for	a given	match. This is the ac-
       tion  that will be taken	when you type return without an	option letter.
       The default is apply.

   languages
       A list of locale	names to search	for preferred  aliases.	 For  example,
       setting	this  to  en uses the transliterated artist name aPyotr	Ilyich
       Tchaikovskya instead of the Cyrillic script  for	 the  composeras  name
       when  tagging  from  MusicBrainz. You can use a space-separated list of
       language	abbreviations, like en jp es, to specify a  preference	order.
       Defaults	to an empty list, meaning that no language is preferred.

   detail
       Whether	the  importer  UI  should show detailed	information about each
       match it	finds. When enabled, this mode prints out the title  of	 every
       track, regardless of whether it matches the original metadata. (The de-
       fault behavior only shows changes.) Default: no.

   group_albums
       By default, the beets importer groups tracks into albums	based  on  the
       directories they	reside in. This	option instead uses filesa metadata to
       partition albums. Enable	this option if you have	directories that  con-
       tain tracks from	many albums mixed together.

       The  --group-albums  or	-g option to the import-cmd command is equiva-
       lent, and the G interactive option invokes the same workflow.

       Default:	no.

   autotag
       By default, the beets importer always attempts to autotag new music. If
       most  of	 your  collection consists of obscure music, you may be	inter-
       ested in	disabling autotagging by setting this option to	no.  (You  can
       re-enable it with the -a	flag to	the import-cmd command.)

       Default:	yes.

   duplicate_action
       Either  skip,  keep, remove, merge or ask.  Controls how	duplicates are
       treated in import task.	askipa means that  new	item(album  or	track)
       will  be	 skipped;  akeepa  means keep both old and new items; aremovea
       means remove old	item; amergea means merge into one album; aaska	 means
       the  user  should  be prompted for the action each time.	The default is
       ask.

   bell
       Ring the	terminal bell to get your attention when  the  importer	 needs
       your input.

       Default:	no.

   set_fields
       A  dictionary indicating	fields to set to values	for newly imported mu-
       sic.  Hereas an example:

	  set_fields:
	      genre: 'To Listen'
	      collection: 'Unordered'

       Other field/value pairs supplied	via  the  --set	 option	 on  the  com-
       mand-line override any settings here for	fields with the	same name.

       Default:	{} (empty).

MUSICBRAINZ OPTIONS
       You  can	instruct beets to use your own MusicBrainz database instead of
       the main	server.	Use  the  host	and  ratelimit	options	 under	a  mu-
       sicbrainz: header, like so:

	  musicbrainz:
	      host: localhost:5000
	      ratelimit: 100

       The  host  key,	of course, controls the	Web server hostname (and port,
       optionally) that	will be	contacted by beets (default: musicbrainz.org).
       The  server  must  have search indices enabled (see Building search in-
       dexes).

       The ratelimit option, an	integer, controls the number  of  Web  service
       requests	 per second (default: 1). Do not change	the rate limit setting
       if youare using the main	 MusicBrainz  serveraon	 this  public  server,
       youare limited to one request per second.

   searchlimit
       The  number  of matches returned	when sending search queries to the Mu-
       sicBrainz server.

       Default:	5.

AUTOTAGGER MATCHING OPTIONS
       You can configure some aspects of the logic beets uses  when  automati-
       cally matching MusicBrainz results under	the match: section. To control
       how   tolerant	the   autotagger   is	of   differences,   use	   the
       strong_rec_thresh  option,  which reflects the distance threshold below
       which beets will	make a astrong recommendationa that  the  metadata  be
       used.  Strong  recommendations  are  accepted  automatically (except in
       atimida mode), so you can use this to make beets	ask your opinion  more
       or less often.

       The threshold is	a distance value between 0.0 and 1.0, so you can think
       of it as	the opposite of	a similarity value. For	example, if  you  want
       to automatically	accept any matches above 90% similarity, use:

	  match:
	      strong_rec_thresh: 0.10

       The default strong recommendation threshold is 0.04.

       The medium_rec_thresh and rec_gap_thresh	options	work similarly.	When a
       match is	below the medium recommendation	threshold or the distance  be-
       tween  it  and  the next-best match is above the	gap threshold, the im-
       porter will suggest that	match but not automatically confirm it.	Other-
       wise, youall see	a list of options to choose from.

   max_rec
       As  mentioned  above, autotagger	matches	have recommendations that con-
       trol how	the UI behaves for a certain quality of	match. The recommenda-
       tion  for a certain match is based on the overall distance calculation.
       But you can also	control	the recommendation when	 a  specific  distance
       penalty is applied by defining maximum recommendations for each field:

       To define maxima, use keys under	max_rec: in the	match section. The de-
       faults are amediuma for	missing	 and  unmatched	 tracks	 and  astronga
       (i.e., no maximum) for everything else:

	  match:
	      max_rec:
		  missing_tracks: medium
		  unmatched_tracks: medium

       If a recommendation is higher than the configured maximum and the indi-
       cated penalty is	applied, the recommendation is downgraded. The setting
       for each	field can be one of none, low, medium or strong. When the max-
       imum recommendation is strong, no adowngradinga occurs.	The  available
       penalty names here are:

       o source

       o artist

       o album

       o media

       o mediums

       o year

       o country

       o label

       o catalognum

       o albumdisambig

       o album_id

       o tracks

       o missing_tracks

       o unmatched_tracks

       o track_title

       o track_artist

       o track_index

       o track_length

       o track_id

   preferred
       In  addition  to	 comparing the tagged metadata with the	match metadata
       for similarity, you can also specify an ordered list of preferred coun-
       tries and media types.

       A  distance  penalty  will be applied if	the country or media type from
       the match metadata doesnat match. The specified values are preferred in
       descending  order  (i.e.,  the first item will be most preferred). Each
       item may	be a regular expression, and will  be  matched	case  insensi-
       tively.	The  number  of	media will be stripped when matching preferred
       media (e.g. a2xa	in a2xCDa).

       You can also tell the autotagger	to prefer matches that have a  release
       year closest to the original year for an	album.

       Hereas an example:

	  match:
	      preferred:
		  countries: ['US', 'GB|UK']
		  media: ['CD',	'Digital Media|File']
		  original_year: yes

       By default, none	of these options are enabled.

   ignored
       You can completely avoid	matches	that have certain penalties applied by
       adding the penalty name to the ignored setting:

	  match:
	      ignored: missing_tracks unmatched_tracks

       The available penalties are the same as those for the max_rec setting.

       For example,  setting  ignored:	missing_tracks	will  skip  any	 album
       matches	where your audio files are missing some	of the tracks. The im-
       porter will not attempt to display these	matches. It  does  not	ignore
       the  fact  that	the  album  is missing tracks, which would allow these
       matches to apply	more easily. To	do that, youall	 want  to  adjust  the
       penalty for missing tracks.

   required
       You  can	 avoid matches that lack certain required information. Add the
       tags you	want to	enforce	to the required	setting:

	  match:
	      required:	year label catalognum country

       No tags are required by default.

   ignored_media
       A list of media (i.e., formats) in metadata databases  to  ignore  when
       matching	 music.	You can	use this to ignore all media that usually con-
       tain video instead of audio, for	example:

	  match:
	      ignored_media: ['Data CD', 'DVD',	'DVD-Video', 'Blu-ray',	'HD-DVD',
			      'VCD', 'SVCD', 'UMD', 'VHS']

       No formats are ignored by default.

   ignore_data_tracks
       By default, audio files contained in data tracks	within a  release  are
       included	in the albumas tracklist. If you want them to be included, set
       it no.

       Default:	yes.

   ignore_video_tracks
       By default, video tracks	within a release will be ignored. If you  want
       them  to	 be  included  (for example if you would like to track the au-
       dio-only	versions of the	video tracks), set it to no.

       Default:	yes.

PATH FORMAT CONFIGURATION
       You can also configure the directory hierarchy beets uses to store  mu-
       sic.  These settings appear under the paths: key. Each string is	a tem-
       plate string that can refer to metadata fields like $artist or  $title.
       The  filename  extension	is added automatically.	At the moment, you can
       specify three special paths: default for	most releases, comp for	avari-
       ous artista releases with no dominant artist, and singleton for non-al-
       bum tracks. The defaults	look like this:

	  paths:
	      default: $albumartist/$album%aunique{}/$track $title
	      singleton: Non-Album/$artist/$title
	      comp: Compilations/$album%aunique{}/$track $title

       Note the	use of $albumartist instead of $artist;	this ensures that  al-
       bums  will  be well-organized. For more about these format strings, see
       pathformat. The aunique{} function ensures that	identically-named  al-
       bums are	placed in different directories; see aunique for details.

       In  addition  to	 default,  comp, and singleton,	you can	condition path
       queries based on	beets queries (see /reference/query). This means  that
       a config	file like this:

	  paths:
	      albumtype:soundtrack: Soundtracks/$album/$track $title

       will  place  soundtrack albums in a separate directory. The queries are
       tested in the order they	appear in the configuration file, meaning that
       if an item matches multiple queries, beets will use the path format for
       the first matching query.

       Note that the special singleton and comp	path format conditions are, in
       fact,  just  shorthand  for  the	 explicit  queries  singleton:true and
       comp:true. In contrast, default is special and has no query equivalent:
       the default format is only used if no queries match.

CONFIGURATION LOCATION
       The  beets configuration	file is	usually	located	in a standard location
       that depends on your OS,	but there are a	couple of ways	you  can  tell
       beets where to look.

   Environment Variable
       First,  you  can	 set  the BEETSDIR environment variable	to a directory
       containing a config.yaml	file. This replaces your configuration in  the
       default location. This also affects where auxiliary files, like the li-
       brary database, are stored by default (thatas where relative paths  are
       resolved	 to).  This environment	variable is useful if you need to man-
       age multiple beets libraries with separate configurations.

   Command-Line	Option
       Alternatively, you can use the --config command-line option to indicate
       a  YAML	file containing	options	that will then be merged with your ex-
       isting options (from BEETSDIR or	the default locations).	This is	useful
       if you want to keep your	configuration mostly the same but modify a few
       options as a batch. For example,	you might  have	 different  strategies
       for importing files, each with a	different set of importer options.

   Default Location
       In  the absence of a BEETSDIR variable, beets searches a	few places for
       your configuration, depending on	the platform:

       o On Unix platforms, including OS X:~/.config/beets and then  $XDG_CON-
	 FIG_DIR/beets,	if the environment variable is set.

       o On  OS	 X,  we	also search ~/Library/Application Support/beets	before
	 the Unixy locations.

       o On Windows: ~\AppData\Roaming\beets, and then %APPDATA%\beets,	if the
	 environment variable is set.

       Beets  uses  the	 first directory in your platformas list that contains
       config.yaml. If no config file exists, the last path  in	 the  list  is
       used.

EXAMPLE
       Hereas an example file:

	  directory: /var/mp3
	  import:
	      copy: yes
	      write: yes
	      log: beetslog.txt
	  art_filename:	albumart
	  plugins: bpd
	  pluginpath: ~/beets/myplugins
	  ui:
	      color: yes

	  paths:
	      default: $genre/$albumartist/$album/$track $title
	      singleton: Singletons/$artist - $title
	      comp: $genre/$album/$track $title
	      albumtype:soundtrack: Soundtracks/$album/$track $title

SEE ALSO
       http://beets.readthedocs.org/

       beet(1)

AUTHOR
       Adrian Sampson

COPYRIGHT
       2016, Adrian Sampson

1.4				 May 30, 2019			BEETSCONFIG(5)

NAME | GLOBAL OPTIONS | UI OPTIONS | IMPORTER OPTIONS | MUSICBRAINZ OPTIONS | AUTOTAGGER MATCHING OPTIONS | PATH FORMAT CONFIGURATION | CONFIGURATION LOCATION | EXAMPLE | SEE ALSO | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=beetsconfig&sektion=5&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help