-
Notifications
You must be signed in to change notification settings - Fork 15
/
introduction-commandline.html
72 lines (61 loc) · 4.79 KB
/
introduction-commandline.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!--
Gregorio web site.
Copyright (C) 2007-2015 The Gregorio project
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
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
<title>Gregorio project website</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="description" content="Free software for typesetting Gregorian chant" lang="en">
<meta name="keywords" content="Gregorian chant, gregorio, gabc, gregoriotex" lang="en">
<meta name="author" content="The Gregorio project">
<link rel="shortcut icon" href="./illus/fav.ico">
<link rel="icon" href="./illus/fav.ico">
<link rel="stylesheet" href="./style.css" type="text/css" title="default">
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script type="text/javascript" src="./gregorio-menu.js"></script>
<script>
var context = 'gregorio';
var title = 'Gregorio project website'
</script>
</head>
<body>
<div id="ban">
<img src="./illus/harpedroite.png" title="" class="hd" alt="" />
<a id="haut" name="haut"></a>
<div id="banniere">
</div>
</div>
<script>write_gre_menu();</script>
<div class="flux">
<!-- IE patch-->
<div class="text">
<!-- End of header -->
<!-- header -->
<h1>Using Gregorio in a terminal</h1>
<p>This page is an introduction to working with Gregorio from the command line. It is intended for users who are familiar with using <span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span> and compiling <span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span> documents at the command line. If that is not the case for you, you can start with <a href="./introduction-editor.html">an editor</a> for <span class="tex">T<span class="epsilon">e</span>X</span> documents.</p>
<p>The command line tool <code>gregorio</code> converts a score file written in <a href="./gabc/index.html">gabc</a> notation into a TeX file. That <span class="tex">T<span class="epsilon">e</span>X</span> file contains commands for the Gregorio<span class="tex">T<span class="epsilon">e</span>X</span> package.</p>
<p>Your <span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span> file incorporates the score into a document by means of the Gregorio<span class="tex">T<span class="epsilon">e</span>X</span> command <code>\gregorioscore</code>. This command takes one or two arguments: The first argument is optional and should be enclosed in square brackets (<code>[]</code>) if it is given. This argument is a single letter, <code>a</code>, <code>f</code>, or <code>n</code>, and indicates the compilation behavior that should be observed for this score. The default value of this optional argument can be set with a package option or via a macro specifically designed for this purpose. See the GregorioRef for more details. The second argument is required and is the filename of your gabc score (enclosed in curly braces: <code>{}</code>).</p>
<p>Gregorio extensively uses the new features of Lua<span class="tex">T<span class="epsilon">e</span>X</span>, so you must compile your <span class="tex">T<span class="epsilon">e</span>X</span> files with <code>lualatex</code> (for <span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span> documents) or <code>luatex</code> (for Plain <span class="tex">T<span class="epsilon">e</span>X</span> documents). Also, in order to compile your scores automatically, <code>lualatex</code> needs to be able to run external commands. To allow that, run <code>lualatex</code> with the <code>‑‑shell‑escape</code> switch, or add <code>gregorio</code> to the list of commands allowed under restricted command execution: the list is named <code>shell_escape_commands</code> in <code>texmf.cnf</code>.
<p>Behind the scenes, the automatic compilation (when enabled) creates <code>myfile-###.gtex</code> where <code>myfile</code> is the base name of your gabc score and <code>###</code> is the version of Gregorio.</p>
<!-- footer -->
</div>
<div class="bottom">
</div>
<script>initialize_menu();</script>
</body>
</html>