mu-scm: add man-page

Not much yet.
This commit is contained in:
Dirk-Jan C. Binnema
2025-06-16 17:40:29 +03:00
parent caeb2ab3c9
commit 24a6d7725e
2 changed files with 47 additions and 2 deletions

View File

@ -1,4 +1,4 @@
## Copyright (C) 2021-2023 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> ## Copyright (C) 2021-2025 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
## ##
## This program is free software; you can redistribute it and/or modify ## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by ## it under the terms of the GNU General Public License as published by
@ -43,7 +43,7 @@ foreach inc: incs
endforeach endforeach
# man-pages is org-format. # man-pages is org-format.
man_orgs=[ man_orgs = [
'mu.1.org', 'mu.1.org',
'mu-add.1.org', 'mu-add.1.org',
'mu-bookmarks.5.org', 'mu-bookmarks.5.org',
@ -59,6 +59,7 @@ man_orgs=[
'mu-move.1.org', 'mu-move.1.org',
'mu-query.7.org', 'mu-query.7.org',
'mu-remove.1.org', 'mu-remove.1.org',
'mu-scm.1.org',
'mu-server.1.org', 'mu-server.1.org',
'mu-verify.1.org', 'mu-verify.1.org',
'mu-view.1.org' 'mu-view.1.org'

44
man/mu-scm.1.org Normal file
View File

@ -0,0 +1,44 @@
#+TITLE: MU SCM
#+MAN_CLASS_OPTIONS: :section-id "@SECTION_ID@" :date "@MAN_DATE@"
#+include: macros.inc
* NAME
*mu scm* - bindings and shell for the GNU Guile programming language.
* SYNOPSIS
*mu scm* [_COMMON-OPTIONS_]
starts the GNU Guile shell.
*mu scm* [_COMMON-OPTIONS_] [[_COMMAND_] -- [_COMMAND-OPTIONS_]]
runs a GNU Guile script.
* DESCRIPTION
*mu scm* is the command to use the bindings to the GNU Guile programming language.
It can either open a shell ("REPL") or run scripts.
Using *mu scm*, you can script *mu*.
#+include: "common-options.inc" :minlevel 1
#+include: "exit-code.inc" :minlevel 1
* ENVIRONMENT
By default, *mu scm* expects its internal files to be found in
~<prefix>/hare/mu/scm~. However, for development/testing you can set the
environment variable *MU_SCM_DIR* to some alternative directory.
* SEE ALSO
The full documentation for *mu scm* is maintained as a Texinfo manual. If the *info*
and *mu* programs are properly installed at your site, the command *info mu-scm*
should give you access to the complete manual.
http://www.schemers.org provides a general introduction to the Scheme language.
#+include: "prefooter.inc" :minlevel 1