mu-script(1)

1MU(SCRIPT)                       User Manuals                       MU(SCRIPT)
2
3
4

NAME

6       mu script- show the available mu scripts, and/or run them.
7
8

SYNOPSIS

10       mu script [options] [<pattern>]
11
12       mu <script-name> [<script-options>]
13
14

DESCRIPTION

16       mu  script is the mu command to list available mu scripts.  The scripts
17       are to be implemented in the Guile programming language, and  therefore
18       only work if your mu is built with support for Guile. In addition, many
19       scripts require you to have gnuplot installed.
20
21       Without any parameters, mu script lists the available scripts.  If  you
22       provide  a  pattern (a regular expression), only the scripts whose name
23       or one-line description match this pattern are listed. See the examples
24       below.
25
26       mu ships with a number of scripts.
27
28

OPTIONS

30       --verbose,-v
31              when listing the available scripts, show the long descriptions.
32
33              --  all  options  on  the right side of the -- are passed to the
34              script.
35
36

EXAMPLES

38       List all available scripts (one-line descriptions):
39         $ mu script
40
41       List all available scripts matching month (long descriptions):
42         $ mu script -v month
43
44       Run the msgs-per-month script for messages matching 'hello',  and  pass
45       it the --textonly parameter:
46         $ mu msgs-per-month --query=hello --textonly
47
48

RETURN VALUE

50       mu script returns 0 when all went well, and returns some non-zero error
51       code when this is not the case.
52
53

FILES

55       You can make your own Scheme scripts accessible through  mu  script  by
56       putting   them   in  either  <XDG_DATA_HOME>/mu/scripts  (e.g.,  ~/.lo‐
57       cal/share/mu/scripts) or, if muhome is specified, in
58
59       It is a good idea to document the scripts by using  some  special  com‐
60       ments in the source code:
61       ;; INFO: this is my script -- one-line description
62       ;; INFO: (longer description)
63       ;; INFO: --option1=<foo> (describe option1)
64       ;; INFO: etc.
65
66

BUGS

68       Please report bugs if you find them: https://github.com/djcb/mu/issues
69
70

AUTHOR

72       Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
73
74