Skip to content

Commit

Permalink
Add man page for mpprc
Browse files Browse the repository at this point in the history
  • Loading branch information
@doctorfree
doctorfree committed Jan 20, 2023
1 parent e8b564f commit 2c5a670
Show file tree
Hide file tree
Showing 7 changed files with 679 additions and 133 deletions.
130 changes: 65 additions & 65 deletions bin/mppinit
View file
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,45 @@ save_mpp_conf() {
fi
fi

echo "" >> ${MPPCONF}
echo "## Service access" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# The Bandcamp username can be found by visiting Bandcamp 'Settings' -> 'Fan'" >> ${MPPCONF}
echo "# If you do not have a Bandcamp account, leave blank" >> ${MPPCONF}
echo "BANDCAMP_USER=${BANDCAMP_USER}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# The Discogs username can be found by visiting discogs.com. Login, use the" >> ${MPPCONF}
echo "# dropdown of your user icon in the upper right corner, click on 'Profile'." >> ${MPPCONF}
echo "# Your Discogs username is the last component of the profile URL." >> ${MPPCONF}
echo "DISCOGS_USER=${DISCOGS_USER}" >> ${MPPCONF}
echo "# The Discogs API token can be found by visiting" >> ${MPPCONF}
echo "# https://www.discogs.com/settings/developers" >> ${MPPCONF}
echo "DISCOGS_TOKEN=${DISCOGS_TOKEN}" >> ${MPPCONF}
echo "# Location of the generated custom Discogs Obsidian vault" >> ${MPPCONF}
echo "# Can be anywhere you have write permission" >> ${MPPCONF}
echo "DISCOGS_DIR=\"${DISCOGS_DIR}\"" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your Last.fm username, api key, and api secret" >> ${MPPCONF}
echo "# If you do not have a Last.fm account, leave blank" >> ${MPPCONF}
echo "LASTFM_USER=${LASTFM_USER}" >> ${MPPCONF}
echo "LASTFM_APIKEY=${LASTFM_APIKEY}" >> ${MPPCONF}
echo "LASTFM_SECRET=${LASTFM_SECRET}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# The Soundcloud user slug can be found by logging in to Soundcloud" >> ${MPPCONF}
echo "# click on the username at top right then 'Profile'. The user slug" >> ${MPPCONF}
echo "# is the last component of the URL when viewing your Soundcloud Profile." >> ${MPPCONF}
echo "# If you do not have a Soundcloud account, leave blank" >> ${MPPCONF}
echo "SOUNDCLOUD_SLUG=${SOUNDCLOUD_SLUG}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your Spotify client id and client secret" >> ${MPPCONF}
echo "# If you do not have a Spotify account, leave blank" >> ${MPPCONF}
echo "SPOTIFY_CLIENT=${SPOTIFY_CLIENT}" >> ${MPPCONF}
echo "SPOTIFY_SECRET=${SPOTIFY_SECRET}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your YouTube api key" >> ${MPPCONF}
echo "# If you do not have a YouTube account, leave blank" >> ${MPPCONF}
echo "YOUTUBE_APIKEY=${YOUTUBE_APIKEY}" >> ${MPPCONF}

echo "" >> ${MPPCONF}
echo "## Album cover art position" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
Expand Down Expand Up @@ -658,45 +697,6 @@ save_mpp_conf() {
else
echo "# font_override_height=45" >> ${MPPCONF}
fi

echo "" >> ${MPPCONF}
echo "## Service access" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# The Bandcamp username can be found by visiting Bandcamp 'Settings' -> 'Fan'" >> ${MPPCONF}
echo "# If you do not have a Bandcamp account, leave blank" >> ${MPPCONF}
echo "BANDCAMP_USER=${BANDCAMP_USER}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# The Discogs username can be found by visiting discogs.com. Login, use the" >> ${MPPCONF}
echo "# dropdown of your user icon in the upper right corner, click on 'Profile'." >> ${MPPCONF}
echo "# Your Discogs username is the last component of the profile URL." >> ${MPPCONF}
echo "DISCOGS_USER=${DISCOGS_USER}" >> ${MPPCONF}
echo "# The Discogs API token can be found by visiting" >> ${MPPCONF}
echo "# https://www.discogs.com/settings/developers" >> ${MPPCONF}
echo "DISCOGS_TOKEN=${DISCOGS_TOKEN}" >> ${MPPCONF}
echo "# Location of the generated custom Discogs Obsidian vault" >> ${MPPCONF}
echo "# Can be anywhere you have write permission" >> ${MPPCONF}
echo "DISCOGS_DIR=\"${DISCOGS_DIR}\"" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your Last.fm username, api key, and api secret" >> ${MPPCONF}
echo "# If you do not have a Last.fm account, leave blank" >> ${MPPCONF}
echo "LASTFM_USER=${LASTFM_USER}" >> ${MPPCONF}
echo "LASTFM_APIKEY=${LASTFM_APIKEY}" >> ${MPPCONF}
echo "LASTFM_SECRET=${LASTFM_SECRET}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# The Soundcloud user slug can be found by logging in to Soundcloud" >> ${MPPCONF}
echo "# click on the username at top right then 'Profile'. The user slug" >> ${MPPCONF}
echo "# is the last component of the URL when viewing your Soundcloud Profile." >> ${MPPCONF}
echo "# If you do not have a Soundcloud account, leave blank" >> ${MPPCONF}
echo "SOUNDCLOUD_SLUG=${SOUNDCLOUD_SLUG}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your Spotify client id and client secret" >> ${MPPCONF}
echo "# If you do not have a Spotify account, leave blank" >> ${MPPCONF}
echo "SPOTIFY_CLIENT=${SPOTIFY_CLIENT}" >> ${MPPCONF}
echo "SPOTIFY_SECRET=${SPOTIFY_SECRET}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your YouTube api key" >> ${MPPCONF}
echo "# If you do not have a YouTube account, leave blank" >> ${MPPCONF}
echo "YOUTUBE_APIKEY=${YOUTUBE_APIKEY}" >> ${MPPCONF}
chmod 600 ${MPPCONF}
}

Expand Down Expand Up @@ -757,32 +757,6 @@ init_mpp_conf() {
echo "#MPP_MODE=tilix" >> ${MPPCONF}
echo "MPP_MODE=${DEFAULT_MODE}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "## Album cover art position" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# Album cover art is positioned within the preferred terminal window with" >> ${MPPCONF}
echo "# padding values hard coded in the cover art display script. These padding" >> ${MPPCONF}
echo "# values are customized for each of the supported terminal emulators. The" >> ${MPPCONF}
echo "# default padding values should suffice but they can be overriden here. To" >> ${MPPCONF}
echo "# override the padding values, set OVERRIDE_PADDING=1 and set any or all of" >> ${MPPCONF}
echo "# the 'padding_override_*' values to adjust album cover art placement. See" >> ${MPPCONF}
echo "# ~/.config/mpcplus/ueberzug/mpcplus_cover_art.sh for default padding values." >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# Set to 1 to override default padding, leave unset to use custom defaults" >> ${MPPCONF}
echo "OVERRIDE_PADDING=" >> ${MPPCONF}
echo "# Uncomment any or all and set preferred padding value(s)" >> ${MPPCONF}
echo "# padding_override_top=3" >> ${MPPCONF}
echo "# padding_override_bottom=1" >> ${MPPCONF}
echo "# padding_override_right=0" >> ${MPPCONF}
echo "# padding_override_left=1" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# The font size in pixels is set to 22x45 for album cover art display." >> ${MPPCONF}
echo "# To override this, set OVERRIDE_FONT_SIZE=1 and adjust the font width and/or" >> ${MPPCONF}
echo "# font height in pixels to match your system." >> ${MPPCONF}
echo "OVERRIDE_FONT_SIZE=" >> ${MPPCONF}
echo "# Uncomment either or both and set font width and/or font height value(s)" >> ${MPPCONF}
echo "# font_override_width=22" >> ${MPPCONF}
echo "# font_override_height=45" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "## Service access" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# The Bandcamp username can be found by visiting Bandcamp 'Settings' -> 'Fan'" >> ${MPPCONF}
Expand Down Expand Up @@ -820,6 +794,32 @@ init_mpp_conf() {
echo "# Your YouTube api key" >> ${MPPCONF}
echo "# If you do not have a YouTube account, leave blank" >> ${MPPCONF}
echo "YOUTUBE_APIKEY=" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "## Album cover art position" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# Album cover art is positioned within the preferred terminal window with" >> ${MPPCONF}
echo "# padding values hard coded in the cover art display script. These padding" >> ${MPPCONF}
echo "# values are customized for each of the supported terminal emulators. The" >> ${MPPCONF}
echo "# default padding values should suffice but they can be overriden here. To" >> ${MPPCONF}
echo "# override the padding values, set OVERRIDE_PADDING=1 and set any or all of" >> ${MPPCONF}
echo "# the 'padding_override_*' values to adjust album cover art placement. See" >> ${MPPCONF}
echo "# ~/.config/mpcplus/ueberzug/mpcplus_cover_art.sh for default padding values." >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# Set to 1 to override default padding, leave unset to use custom defaults" >> ${MPPCONF}
echo "OVERRIDE_PADDING=" >> ${MPPCONF}
echo "# Uncomment any or all and set preferred padding value(s)" >> ${MPPCONF}
echo "# padding_override_top=3" >> ${MPPCONF}
echo "# padding_override_bottom=1" >> ${MPPCONF}
echo "# padding_override_right=0" >> ${MPPCONF}
echo "# padding_override_left=1" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# The font size in pixels is set to 22x45 for album cover art display." >> ${MPPCONF}
echo "# To override this, set OVERRIDE_FONT_SIZE=1 and adjust the font width and/or" >> ${MPPCONF}
echo "# font height in pixels to match your system." >> ${MPPCONF}
echo "OVERRIDE_FONT_SIZE=" >> ${MPPCONF}
echo "# Uncomment either or both and set font width and/or font height value(s)" >> ${MPPCONF}
echo "# font_override_width=22" >> ${MPPCONF}
echo "# font_override_height=45" >> ${MPPCONF}
fi
chmod 600 ${MPPCONF}
}
Expand Down
78 changes: 39 additions & 39 deletions bin/mpplus
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3247,6 +3247,45 @@ save_config() {
fi
fi

echo "" >> ${MPPCONF}
echo "## Service access" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# The Bandcamp username can be found by visiting Bandcamp 'Settings' -> 'Fan'" >> ${MPPCONF}
echo "# If you do not have a Bandcamp account, leave blank" >> ${MPPCONF}
echo "BANDCAMP_USER=${BANDCAMP_USER}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# The Discogs username can be found by visiting discogs.com. Login, use the" >> ${MPPCONF}
echo "# dropdown of your user icon in the upper right corner, click on 'Profile'." >> ${MPPCONF}
echo "# Your Discogs username is the last component of the profile URL." >> ${MPPCONF}
echo "DISCOGS_USER=${DISCOGS_USER}" >> ${MPPCONF}
echo "# The Discogs API token can be found by visiting" >> ${MPPCONF}
echo "# https://www.discogs.com/settings/developers" >> ${MPPCONF}
echo "DISCOGS_TOKEN=${DISCOGS_TOKEN}" >> ${MPPCONF}
echo "# Location of the generated custom Discogs Obsidian vault" >> ${MPPCONF}
echo "# Can be anywhere you have write permission" >> ${MPPCONF}
echo "DISCOGS_DIR=\"${DISCOGS_DIR}\"" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your Last.fm username, api key, and api secret" >> ${MPPCONF}
echo "# If you do not have a Last.fm account, leave blank" >> ${MPPCONF}
echo "LASTFM_USER=${LASTFM_USER}" >> ${MPPCONF}
echo "LASTFM_APIKEY=${LASTFM_APIKEY}" >> ${MPPCONF}
echo "LASTFM_SECRET=${LASTFM_SECRET}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# The Soundcloud user slug can be found by logging in to Soundcloud" >> ${MPPCONF}
echo "# click on the username at top right then 'Profile'. The user slug" >> ${MPPCONF}
echo "# is the last component of the URL when viewing your Soundcloud Profile." >> ${MPPCONF}
echo "# If you do not have a Soundcloud account, leave blank" >> ${MPPCONF}
echo "SOUNDCLOUD_SLUG=${SOUNDCLOUD_SLUG}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your Spotify client id and client secret" >> ${MPPCONF}
echo "# If you do not have a Spotify account, leave blank" >> ${MPPCONF}
echo "SPOTIFY_CLIENT=${SPOTIFY_CLIENT}" >> ${MPPCONF}
echo "SPOTIFY_SECRET=${SPOTIFY_SECRET}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your YouTube api key" >> ${MPPCONF}
echo "# If you do not have a YouTube account, leave blank" >> ${MPPCONF}
echo "YOUTUBE_APIKEY=${YOUTUBE_APIKEY}" >> ${MPPCONF}

echo "" >> ${MPPCONF}
echo "## Album cover art position" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
Expand Down Expand Up @@ -3303,45 +3342,6 @@ save_config() {
else
echo "# font_override_height=45" >> ${MPPCONF}
fi

echo "" >> ${MPPCONF}
echo "## Service access" >> ${MPPCONF}
echo "#" >> ${MPPCONF}
echo "# The Bandcamp username can be found by visiting Bandcamp 'Settings' -> 'Fan'" >> ${MPPCONF}
echo "# If you do not have a Bandcamp account, leave blank" >> ${MPPCONF}
echo "BANDCAMP_USER=${BANDCAMP_USER}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# The Discogs username can be found by visiting discogs.com. Login, use the" >> ${MPPCONF}
echo "# dropdown of your user icon in the upper right corner, click on 'Profile'." >> ${MPPCONF}
echo "# Your Discogs username is the last component of the profile URL." >> ${MPPCONF}
echo "DISCOGS_USER=${DISCOGS_USER}" >> ${MPPCONF}
echo "# The Discogs API token can be found by visiting" >> ${MPPCONF}
echo "# https://www.discogs.com/settings/developers" >> ${MPPCONF}
echo "DISCOGS_TOKEN=${DISCOGS_TOKEN}" >> ${MPPCONF}
echo "# Location of the generated custom Discogs Obsidian vault" >> ${MPPCONF}
echo "# Can be anywhere you have write permission" >> ${MPPCONF}
echo "DISCOGS_DIR=\"${DISCOGS_DIR}\"" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your Last.fm username, api key, and api secret" >> ${MPPCONF}
echo "# If you do not have a Last.fm account, leave blank" >> ${MPPCONF}
echo "LASTFM_USER=${LASTFM_USER}" >> ${MPPCONF}
echo "LASTFM_APIKEY=${LASTFM_APIKEY}" >> ${MPPCONF}
echo "LASTFM_SECRET=${LASTFM_SECRET}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# The Soundcloud user slug can be found by logging in to Soundcloud" >> ${MPPCONF}
echo "# click on the username at top right then 'Profile'. The user slug" >> ${MPPCONF}
echo "# is the last component of the URL when viewing your Soundcloud Profile." >> ${MPPCONF}
echo "# If you do not have a Soundcloud account, leave blank" >> ${MPPCONF}
echo "SOUNDCLOUD_SLUG=${SOUNDCLOUD_SLUG}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your Spotify client id and client secret" >> ${MPPCONF}
echo "# If you do not have a Spotify account, leave blank" >> ${MPPCONF}
echo "SPOTIFY_CLIENT=${SPOTIFY_CLIENT}" >> ${MPPCONF}
echo "SPOTIFY_SECRET=${SPOTIFY_SECRET}" >> ${MPPCONF}
echo "" >> ${MPPCONF}
echo "# Your YouTube api key" >> ${MPPCONF}
echo "# If you do not have a YouTube account, leave blank" >> ${MPPCONF}
echo "YOUTUBE_APIKEY=${YOUTUBE_APIKEY}" >> ${MPPCONF}
chmod 600 ${MPPCONF}
}

Expand Down
52 changes: 26 additions & 26 deletions config/mpprc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,32 +47,6 @@ USE_TMUX=1
#MPP_MODE=tilix
MPP_MODE=kitty

## Album cover art position
#
# Album cover art is positioned within the preferred terminal window with
# padding values hard coded in the cover art display script. These padding
# values are customized for each of the supported terminal emulators. The
# default padding values should suffice but they can be overriden here. To
# override the padding values, set OVERRIDE_PADDING=1 and set any or all of
# the 'padding_override_*' values to adjust album cover art placement. See
# ~/.config/mpcplus/ueberzug/mpcplus_cover_art.sh for default padding values.
#
# Set to 1 to override default padding, leave unset to use custom defaults
OVERRIDE_PADDING=
# Uncomment any or all and set preferred padding value(s)
# padding_override_top=3
# padding_override_bottom=1
# padding_override_right=0
# padding_override_left=1
#
# The font size in pixels is set to 22x45 for album cover art display.
# To override this, set OVERRIDE_FONT_SIZE=1 and adjust the font width and/or
# font height in pixels to match your system.
OVERRIDE_FONT_SIZE=
# Uncomment either or both and set font width and/or font height value(s)
# font_override_width=22
# font_override_height=45

## Service access
#
# The Bandcamp username can be found by visiting Bandcamp 'Settings' -> 'Fan'
Expand Down Expand Up @@ -110,3 +84,29 @@ SPOTIFY_SECRET=
# Your YouTube api key
# If you do not have a YouTube account, leave blank
YOUTUBE_APIKEY=

## Album cover art position
#
# Album cover art is positioned within the preferred terminal window with
# padding values hard coded in the cover art display script. These padding
# values are customized for each of the supported terminal emulators. The
# default padding values should suffice but they can be overriden here. To
# override the padding values, set OVERRIDE_PADDING=1 and set any or all of
# the 'padding_override_*' values to adjust album cover art placement. See
# ~/.config/mpcplus/ueberzug/mpcplus_cover_art.sh for default padding values.
#
# Set to 1 to override default padding, leave unset to use custom defaults
OVERRIDE_PADDING=
# Uncomment any or all and set preferred padding value(s)
# padding_override_top=3
# padding_override_bottom=1
# padding_override_right=0
# padding_override_left=1
#
# The font size in pixels is set to 22x45 for album cover art display.
# To override this, set OVERRIDE_FONT_SIZE=1 and adjust the font width and/or
# font height in pixels to match your system.
OVERRIDE_FONT_SIZE=
# Uncomment either or both and set font width and/or font height value(s)
# font_override_width=22
# font_override_height=45
8 changes: 6 additions & 2 deletions man/man1/mpplus.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,10 @@ Valid values for \f[V]opt\f[R] are \[aq]a\[aq], \[aq]A\[aq],
.TP
\f[B]-u\f[R]
Displays this usage message and exits
.SS CONFIGURATION
.PP
See \f[V]man mpprc\f[R] for a detailed description of each of the
\f[V]mpplus\f[R] configuration options in \f[V]\[ti]/.config/mpprc\f[R].
.SS EXAMPLES
.TP
\f[B]mpplus\f[R]
Expand Down Expand Up @@ -361,8 +365,8 @@ Submit bug reports online at:
<https://github.com/doctorfree/MusicPlayerPlus/issues>
.SS SEE ALSO
.PP
\f[B]mppcava\f[R](1), \f[B]mppsplash\f[R](1), \f[B]mpcplus\f[R](1),
\f[B]mpcpluskeys\f[R](1)
\f[B]mpprc\f[R](5), \f[B]mppcava\f[R](1), \f[B]mppsplash\f[R](1),
\f[B]mpcplus\f[R](1), \f[B]mpcpluskeys\f[R](1)
.PP
Full documentation and sources at:
.PP
Expand Down
Loading

0 comments on commit 2c5a670

Please sign in to comment.