mu_script - show the available mu scripts, and/or run them.
Contents
Bugs
Please report bugs if you find them: https://github.com/djcb/mu/issuesDescription
muscript is the mu command to list available mu scripts. The scripts are to be implemented in the Guile
programming language, and therefore only work if your mu is built with support for Guile. In addition,
many scripts require you to have gnuplot installed.
Without any parameters, muscript lists the available scripts. If you provide a pattern (a regular
expression), only the scripts whose name or one-line description match this pattern are listed. See the
examples below.
mu ships with a number of scripts.
Examples
List all available scripts (one-line descriptions):
$ mu script
List all available scripts matching month (long descriptions):
$ mu script -v month
Run the msgs-per-month script for messages matching 'hello', and pass it the --textonly parameter:
$ mu msgs-per-month --query=hello --textonly
Files
You can make your own Scheme scripts accessible through muscript by putting them in either
<XDG_DATA_HOME>/mu/scripts (e.g., ~/.local/share/mu/scripts) or, if muhome is specified, in
It is a good idea to document the scripts by using some special comments in the source code:
;; INFO: this is my script -- one-line description
;; INFO: (longer description)
;; INFO: --option1=<foo> (describe option1)
;; INFO: etc.
Name
mu_script - show the available mu scripts, and/or run them.
Options
--verbose,-v
when listing the available scripts, show the long descriptions.
-- all options on the right side of the -- are passed to the script.
Return Value
muscript returns 0 when all went well, and returns some non-zero error code when this is not the case.
See Also
mu(1), guile(1) User Manuals October 2021 MU-SCRIPT(1)
Synopsis
muscript[options][<pattern>]mu<script-name>[<script-options>]
