package shakuhachi

  1. Overview
  2. Docs
A music collection manager

Install

dune-project
 Dependency

Authors

Maintainers

Sources

shakuhachi-0.4.0.tar.gz
sha256=8bd4675792ec93d705e68d4e43dc04aa1124fcaf644ae3a1a3fda68464276f95
sha512=712efcbe13e6e9d3336f72c2c25d4b41225cdd245f21adeeadc8aa4ad31ca9c905077e0873a3d1165d7c09357c009c859c4a7cd9c2d0c9bffc27144525594e72

doc/shakuhachi.config/SkhcConfig/Format/index.html

Module SkhcConfig.FormatSource

Operations on the .format section.

Sourcetype t

type of the format section.

Sourceval section : string

section name

Sourceval default : t

default is the section used if the format section is missing from the configuration file.

Sourceval init : filename:string -> artist_artwork:string -> album_cover:string -> music_list:string -> album_list:string -> artist_list:string -> music_remove:string -> t

init ~filename ~artist_artwork ~album_cover ~music_list ~album_list ~artist_list ~music_remove create a format section with filename, artist_artwork, album_cover, music_list, album_list, artist_list and music_remove.

  • since 0.2.0, [artist_artwork] and [album_cover] new parameters.
Sourceval of_section : Section.t -> t

of_section section parse section to create a format section. If an expected key is missing from section, the key is associated with its default value.

Sourceval to_section : t -> Section.t

to_section format serializes format into a section.

Sourceval filename : t -> string

filename format returns the formatting used for naming a music file.

Sourceval artist_artwork : t -> string

artist_cover format returns the formatting used for naming an artist's artwork.

  • since 0.2.0
Sourceval album_cover : t -> string

album_cover format returns the formatting used for naming an album's cover.

  • since 0.2.0
Sourceval music_list : t -> string

music_list format returns the formatting used when listing musics.

Sourceval artist_list : t -> string

artist format returns the formatting used when listing artists.

Sourceval album_list : t -> string

album_list format returns the formatting used when listing albums.

Sourceval music_remove : t -> string

music_remove format returns the formatting used when removing musics.