all repos — h3rald @ 5173cc418660354361abf80241d6860e80ab318e

The sources of https://h3rald.com

assets/pls/Pls_UserGuide.htm

 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
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
 1000
 1001
 1002
 1003
 1004
 1005
 1006
 1007
 1008
 1009
 1010
 1011
 1012
 1013
 1014
 1015
 1016
 1017
 1018
 1019
 1020
 1021
 1022
 1023
 1024
 1025
 1026
 1027
 1028
 1029
 1030
 1031
 1032
 1033
 1034
 1035
 1036
 1037
 1038
 1039
 1040
 1041
 1042
 1043
 1044
 1045
 1046
 1047
 1048
 1049
 1050
 1051
 1052
 1053
 1054
 1055
 1056
 1057
 1058
 1059
 1060
 1061
 1062
 1063
 1064
 1065
 1066
 1067
 1068
 1069
 1070
 1071
 1072
 1073
 1074
 1075
 1076
 1077
 1078
 1079
 1080
 1081
 1082
 1083
 1084
 1085
 1086
 1087
 1088
 1089
 1090
 1091
 1092
 1093
 1094
 1095
 1096
 1097
 1098
 1099
 1100
 1101
 1102
 1103
 1104
 1105
 1106
 1107
 1108
 1109
 1110
 1111
 1112
 1113
 1114
 1115
 1116
 1117
 1118
 1119
 1120
 1121
 1122
 1123
 1124
 1125
 1126
 1127
 1128
 1129
 1130
 1131
 1132
 1133
 1134
 1135
 1136
 1137
 1138
 1139
 1140
 1141
 1142
 1143
 1144
 1145
 1146
 1147
 1148
 1149
 1150
 1151
 1152
 1153
 1154
 1155
 1156
 1157
 1158
 1159
 1160
 1161
 1162
 1163
 1164
 1165
 1166
 1167
 1168
 1169
 1170
 1171
 1172
 1173
 1174
 1175
 1176
 1177
 1178
 1179
 1180
 1181
 1182
 1183
 1184
 1185
 1186
 1187
 1188
 1189
 1190
 1191
 1192
 1193
 1194
 1195
 1196
 1197
 1198
 1199
 1200
 1201
 1202
 1203
 1204
 1205
 1206
 1207
 1208
 1209
 1210
 1211
 1212
 1213
 1214
 1215
 1216
 1217
 1218
 1219
 1220
 1221
 1222
 1223
 1224
 1225
 1226
 1227
 1228
 1229
 1230
 1231
 1232
 1233
 1234
 1235
 1236
 1237
 1238
 1239
 1240
 1241
 1242
 1243
 1244
 1245
 1246
 1247
 1248
 1249
 1250
 1251
 1252
 1253
 1254
 1255
 1256
 1257
 1258
 1259
 1260
 1261
 1262
 1263
 1264
 1265
 1266
 1267
 1268
 1269
 1270
 1271
 1272
 1273
 1274
 1275
 1276
 1277
 1278
 1279
 1280
 1281
 1282
 1283
 1284
 1285
 1286
 1287
 1288
 1289
 1290
 1291
 1292
 1293
 1294
 1295
 1296
 1297
 1298
 1299
 1300
 1301
 1302
 1303
 1304
 1305
 1306
 1307
 1308
 1309
 1310
 1311
 1312
 1313
 1314
 1315
 1316
 1317
 1318
 1319
 1320
 1321
 1322
 1323
 1324
 1325
 1326
 1327
 1328
 1329
 1330
 1331
 1332
 1333
 1334
 1335
 1336
 1337
 1338
 1339
 1340
 1341
 1342
 1343
 1344
 1345
 1346
 1347
 1348
 1349
 1350
 1351
 1352
 1353
 1354
 1355
 1356
 1357
 1358
 1359
 1360
 1361
 1362
 1363
 1364
 1365
 1366
 1367
 1368
 1369
 1370
 1371
 1372
 1373
 1374
 1375
 1376
 1377
 1378
 1379
 1380
 1381
 1382
 1383
 1384
 1385
 1386
 1387
 1388
 1389
 1390
 1391
 1392
 1393
 1394
 1395
 1396
 1397
 1398
 1399
 1400
 1401
 1402
 1403
 1404
 1405
 1406
 1407
 1408
 1409
 1410
 1411
 1412
 1413
 1414
 1415
 1416
 1417
 1418
 1419
 1420
 1421
 1422
 1423
 1424
 1425
 1426
 1427
 1428
 1429
 1430
 1431
 1432
 1433
 1434
 1435
 1436
 1437
 1438
 1439
 1440
 1441
 1442
 1443
 1444
 1445
 1446
 1447
 1448
 1449
 1450
 1451
 1452
 1453
 1454
 1455
 1456
 1457
 1458
 1459
 1460
 1461
 1462
 1463
 1464
 1465
 1466
 1467
 1468
 1469
 1470
 1471
 1472
 1473
 1474
 1475
 1476
 1477
 1478
 1479
 1480
 1481
 1482
 1483
 1484
 1485
 1486
 1487
 1488
 1489
 1490
 1491
 1492
 1493
 1494
 1495
 1496
 1497
 1498
 1499
 1500
 1501
 1502
 1503
 1504
 1505
 1506
 1507
 1508
 1509
 1510
 1511
 1512
 1513
 1514
 1515
 1516
 1517
 1518
 1519
 1520
 1521
 1522
 1523
 1524
 1525
 1526
 1527
 1528
 1529
 1530
 1531
 1532
 1533
 1534
 1535
 1536
 1537
 1538
 1539
 1540
 1541
 1542
 1543
 1544
 1545
 1546
 1547
 1548
 1549
 1550
 1551
 1552
 1553
 1554
 1555
 1556
 1557
 1558
 1559
 1560
 1561
 1562
 1563
 1564
 1565
 1566
 1567
 1568
 1569
 1570
 1571
 1572
 1573
 1574
 1575
 1576
 1577
 1578
 1579
 1580
 1581
 1582
 1583
 1584
 1585
 1586
 1587
 1588
 1589
 1590
 1591
 1592
 1593
 1594
 1595
 1596
 1597
 1598
 1599
 1600
 1601
 1602
 1603
 1604
 1605
 1606
 1607
 1608
 1609
 1610
 1611
 1612
 1613
 1614
 1615
 1616
 1617
 1618
 1619
 1620
 1621
 1622
 1623
 1624
 1625
 1626
 1627
 1628
 1629
 1630
 1631
 1632
 1633
 1634
 1635
 1636
 1637
 1638
 1639
 1640
 1641
 1642
 1643
 1644
 1645
 1646
 1647
 1648
 1649
 1650
 1651
 1652
 1653
 1654
 1655
 1656
 1657
 1658
 1659
 1660
 1661
 1662
 1663
 1664
 1665
 1666
 1667
 1668
 1669
 1670
 1671
 1672
 1673
 1674
 1675
 1676
 1677
 1678
 1679
 1680
 1681
 1682
 1683
 1684
 1685
 1686
 1687
 1688
 1689
 1690
 1691
 1692
 1693
 1694
 1695
 1696
 1697
 1698
 1699
 1700
 1701
 1702
 1703
 1704
 1705
 1706
 1707
 1708
 1709
 1710
 1711
 1712
 1713
 1714
 1715
 1716
 1717
 1718
 1719
 1720
 1721
 1722
 1723
 1724
 1725
 1726
 1727
 1728
 1729
 1730
 1731
 1732
 1733
 1734
 1735
 1736
 1737
 1738
 1739
 1740
 1741
 1742
 1743
 1744
 1745
 1746
 1747
 1748
 1749
 1750
 1751
 1752
 1753
 1754
 1755
 1756
 1757
 1758
 1759
 1760
 1761
 1762
 1763
 1764
<!doctype html>
<html lang="en">
<head>
  <title>pls User Guide</title>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta name="author" content="Fabio Cevasco">
  <meta name="generator" content="HastyScribe">
  <style>/*! normalize.css v2.1.3 | MIT License | git.io/normalize */
/* ==========================================================================
   HTML5 display definitions
   ========================================================================== */
/**
 * Correct `block` display not defined in IE 8/9.
 */
article,
aside,
figcaption,
figure,
footer,
header,
hgroup,
main,
nav,
section,
summary {
  display: block;
}
/**
 * Correct `inline-block` display not defined in IE 8/9.
 */
audio,
canvas,
video {
  display: inline-block;
}
/**
 * Prevent modern browsers from displaying `audio` without controls.
 * Remove excess height in iOS 5 devices.
 */
audio:not([controls]) {
  display: none;
  height: 0;
}
/**
 * Address `[hidden]` styling not present in IE 8/9.
 * Hide the `template` element in IE, Safari, and Firefox < 22.
 */
[hidden],
template {
  display: none;
}
/* ==========================================================================
   Base
   ========================================================================== */
/**
 * 1. Set default font family to sans-serif.
 * 2. Prevent iOS text size adjust after orientation change, without disabling
 *    user zoom.
 */
html {
  font-family: sans-serif;
  /* 1 */
  text-size-adjust: 100%;
  /* 2 */
}
/**
 * Remove default margin.
 */
body {
  margin: 0;
}
/* ==========================================================================
   Links
   ========================================================================== */
/**
 * Remove the gray background color from active links in IE 10.
 */
a {
  background: transparent;
}
/**
 * Address `outline` inconsistency between Chrome and other browsers.
 */
a:focus {
  outline: thin dotted;
}
/**
 * Improve readability when focused and also mouse hovered in all browsers.
 */
a:active,
a:hover {
  outline: 0;
}
/* ==========================================================================
   Typography
   ========================================================================== */
/**
 * Address variable `h1` font-size and margin within `section` and `article`
 * contexts in Firefox 4+, Safari 5, and Chrome.
 */
h1 {
  font-size: 2em;
  margin: 0.67em 0;
}
/**
 * Address styling not present in IE 8/9, Safari 5, and Chrome.
 */
abbr[title] {
  border-bottom: 1px dotted;
}
/**
 * Address style set to `bolder` in Firefox 4+, Safari 5, and Chrome.
 */
b,
strong {
  font-weight: bold;
}
/**
 * Address styling not present in Safari 5 and Chrome.
 */
dfn {
  font-style: italic;
}
/**
 * Address differences between Firefox and other browsers.
 */
hr {
  -moz-box-sizing: content-box;
  box-sizing: content-box;
  height: 0;
}
/**
 * Address styling not present in IE 8/9.
 */
mark {
  background: #ff0;
  color: #000;
}
/**
 * Correct font family set oddly in Safari 5 and Chrome.
 */
code,
kbd,
pre,
samp {
  font-family: monospace, serif;
  font-size: 1em;
}
/**
 * Improve readability of pre-formatted text in all browsers.
 */
pre {
  white-space: pre-wrap;
}
/**
 * Set consistent quote types.
 */
q {
  quotes: "\201C" "\201D" "\2018" "\2019";
}
/**
 * Address inconsistent and variable font size in all browsers.
 */
small {
  font-size: 80%;
}
/**
 * Prevent `sub` and `sup` affecting `line-height` in all browsers.
 */
sub,
sup {
  font-size: 75%;
  line-height: 0;
  position: relative;
  vertical-align: baseline;
}
sup {
  top: -0.5em;
}
sub {
  bottom: -0.25em;
}
/* ==========================================================================
   Embedded content
   ========================================================================== */
/**
 * Remove border when inside `a` element in IE 8/9.
 */
img {
  border: 0;
}
/**
 * Correct overflow displayed oddly in IE 9.
 */
svg:not(:root) {
  overflow: hidden;
}
/* ==========================================================================
   Figures
   ========================================================================== */
/**
 * Address margin not present in IE 8/9 and Safari 5.
 */
figure {
  margin: 0;
}
/* ==========================================================================
   Forms
   ========================================================================== */
/**
 * Define consistent border, margin, and padding.
 */
fieldset {
  border: 1px solid #c0c0c0;
  margin: 0 2px;
  padding: 0.35em 0.625em 0.75em;
}
/**
 * 1. Correct `color` not being inherited in IE 8/9.
 * 2. Remove padding so people aren't caught out if they zero out fieldsets.
 */
legend {
  border: 0;
  /* 1 */
  padding: 0;
  /* 2 */
}
/**
 * 1. Correct font family not being inherited in all browsers.
 * 2. Correct font size not being inherited in all browsers.
 * 3. Address margins set differently in Firefox 4+, Safari 5, and Chrome.
 */
button,
input,
select,
textarea {
  font-family: inherit;
  /* 1 */
  font-size: 100%;
  /* 2 */
  margin: 0;
  /* 3 */
}
/**
 * Address Firefox 4+ setting `line-height` on `input` using `!important` in
 * the UA stylesheet.
 */
button,
input {
  line-height: normal;
}
/**
 * Address inconsistent `text-transform` inheritance for `button` and `select`.
 * All other form control elements do not inherit `text-transform` values.
 * Correct `button` style inheritance in Chrome, Safari 5+, and IE 8+.
 * Correct `select` style inheritance in Firefox 4+ and Opera.
 */
button,
select {
  text-transform: none;
}
/**
 * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
 *    and `video` controls.
 * 3. Improve usability and consistency of cursor style between image-type
 *    `input` and others.
 */
button,
html input[type="button"],
input[type="reset"],
input[type="submit"] {
  cursor: pointer;
  /* 3 */
}
/**
 * Re-set default cursor for disabled elements.
 */
button[disabled],
html input[disabled] {
  cursor: default;
}
/**
 * 1. Address box sizing set to `content-box` in IE 8/9/10.
 * 2. Remove excess padding in IE 8/9/10.
 */
input[type="checkbox"],
input[type="radio"] {
  box-sizing: border-box;
  /* 1 */
  padding: 0;
  /* 2 */
}
/**
 * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome
 *    (include `-moz` to future-proof).
 */
input[type="search"] {
  box-sizing: content-box;
}
/**
 * Remove inner padding and border in Firefox 4+.
 */
button::-moz-focus-inner,
input::-moz-focus-inner {
  border: 0;
  padding: 0;
}
/**
 * 1. Remove default vertical scrollbar in IE 8/9.
 * 2. Improve readability and alignment in all browsers.
 */
textarea {
  overflow: auto;
  /* 1 */
  vertical-align: top;
  /* 2 */
}
/* ==========================================================================
   Tables
   ========================================================================== */
/**
 * Remove most spacing between table cells.
 */
table {
  border-collapse: collapse;
  border-spacing: 0;
}
/* Fonts */
/* Colors */
.mix-monospace {
  font-family: monospace;
  font-weight: 400;
}
.mix-no-border-radius {
  border-radius: 0px;
}
@media screen and (max-width: 639px) {
  .mix-responsive {
    overflow-y: hidden;
    overflow-x: auto;
  }
  .mix-responsive td {
    white-space: nowrap;
  }
}
body {
  background-color: #fff;
  margin: 0 auto;
  height: 100%;
  zoom: 1;
  font-weight: 400;
  letter-spacing: normal;
  word-spacing: normal;
  color: #333;
  font: 15px sans-serif;
  line-height: 1.4;
  -webkit-font-smoothing: antialiased;
  width: 960px;
  hyphens: auto;
  text-align: justify;
}
@media screen and (max-width: 659px) {
  body {
    width: 100%;
  }
}
@media screen and (min-width: 660px) {
  body {
    width: 660px;
  }
}
@media screen and (min-width: 880px) {
  body {
    width: 880px;
  }
}
#main,
#footer,
#header {
  width: 94%;
  margin: auto;
}
#footer {
  border-top: 1px solid #ddd;
  text-align: center;
  font-size: 75%;
}
#footer p {
  line-height: 0.6em;
}
#toc {
  margin-top: -10px;
}
#toc ul {
  list-style-type: none;
  padding-left: 20px;
}
#toc > ul {
  padding-left: 0;
}
/* Lists */
ul,
ol {
  padding-left: 30px;
}
li p {
  margin: 0 auto;
}
.unstyled li {
  list-style-type: none;
}
dl dt {
  font-weight: 700;
}
dl dd {
  padding: 0 0 0.2em 0;
}
/* Headings */
h1,
h2,
h3,
h4,
h5,
h6 {
  font-weight: 700;
  color: #111;
  border-bottom: 1px solid #ddd;
}
h1 {
  text-align: center;
}
/* Blocks */
blockquote {
  border-left: 3px solid #dedede;
  padding: 0px 10px;
  margin: 10px 0;
  font-style: italic;
}
pre {
  font-family: monospace;
  font-weight: 400;
  color: #222;
  white-space: pre-wrap;
  margin: auto;
  padding: 0;
}
@media screen and (max-width: 639px) {
  pre {
    overflow-y: hidden;
    overflow-x: auto;
  }
  pre td {
    white-space: nowrap;
  }
}
pre code {
  box-shadow: none;
  border: none;
  line-height: 1.2em;
}
.responsive {
  width: 100%;
}
@media screen and (max-width: 639px) {
  .responsive {
    overflow-y: hidden;
    overflow-x: auto;
  }
  .responsive td {
    white-space: nowrap;
  }
}
table {
  border-collapse: collapse;
  margin: 15px auto;
  border-spacing: 0;
  empty-cells: show;
  min-width: 100%;
}
table thead {
  background: #f8f8f8;
  color: #222;
  text-align: left;
  vertical-align: bottom;
}
table td,
table th {
  background-color: transparent;
  border: 1px solid #999;
  font-size: inherit;
  margin: 0;
  overflow: visible;
  padding: 6px 12px;
}
address {
  font-style: italic;
  color: #999;
}
hr {
  border: 0;
  height: 1px;
  background: #333;
  background-image: linear-gradient(to right, #ccc, #333, #ccc);
}
.center {
  margin: auto;
  text-align: center;
}
/* Inline */
[class^="fa-"]:before,
[href^=http]:before,
[href^=mailto]:before,
[href^=git]:before,
[href^=tel]:before,
[href^=magnet]:before,
[href='#document-top']:before,
[class^="badge-"]:before {
  width: 15px;
  height: 15px;
  background-repeat: no-repeat;
  box-sizing: border-box;
  content: ' ';
  display: inline-block;
  vertical-align: text-top;
}
.tip > p:first-child:before,
.warning > p:first-child:before,
.sidebar > p:first-child:before,
.note > p:first-child:before {
  width: 15px;
  height: 15px;
  background-repeat: no-repeat;
  box-sizing: border-box;
  content: ' ';
  display: inline-block;
  vertical-align: text-top;
  margin-right: 2px;
}
[href^=http]:before,
[href^=mailto]:before,
[href^=git]:before,
[href^=tel]:before,
[href^=magnet]:before {
  margin-right: 2px;
}
[href='#document-top'] {
  float: right;
}
[href='#document-top']:before {
  width: 12px;
  height: 12px;
}
#footer a:before {
  background: none;
}
#footer a:hover {
  text-decoration: none;
}
#footer a:after {
  content: none;
}
code,
span.code {
  font-family: monospace;
  font-weight: 400;
  hyphens: none;
  color: #B2361E;
  font-size: 85%;
}
strong code,
b code {
  font-weight: 700;
}
kbd,
span.kbd {
  color: #222;
  background-color: #f8f8f8;
  padding: 0 3px 0;
  display: inline-block;
  width: auto;
  margin: 1px;
  border-radius: 2px;
  background-clip: padding-box;
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  font-family: monospace;
  font-weight: 700;
  border-right: 1px solid #bbb;
  border-bottom: 1px solid #bbb;
  line-height: 1em;
  font-size: 80%;
  hyphens: none;
}
mark,
span.mark {
  padding: 0 1px;
  color: #222;
}
abbr,
span.abbr {
  font-variant: small-caps;
  font-weight: 700;
  hyphens: none;
}
abbr:hover,
span.abbr:hover {
  cursor: help;
}
samp,
span.samp {
  font-size: 90%;
  color: #222;
  background-color: transparent;
  padding: 0 3px 0;
  display: inline-block;
  width: auto;
  margin: 1px;
  border-radius: 2px;
  background-clip: padding-box;
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  hyphens: none;
}
var,
span.var {
  font-size: 90%;
  font-family: monospace;
  font-weight: 700;
  font-style: normal;
  hyphens: none;
}
cite,
span.cite {
  font-weight: 700;
  font-style: italic;
  hyphens: none;
}
q,
span.q {
  font-style: italic;
  color: #666;
  hyphens: none;
}
span.tt,
span.cmd,
span.opt,
span.arg,
span.kwd,
span.ext,
span.file,
span.dir {
  font-size: 90%;
  font-family: monospace;
  font-weight: 400;
  hyphens: none;
}
span.ext,
span.kwd {
  font-weight: 700;
}
img {
  max-width: 100%;
}
/* Links */
a,
a:visited {
  color: #4183c4;
  text-decoration: none;
}
a:hover,
a:visited:hover {
  text-decoration: underline;
}
a.hastyscribe-logo:before {
  display: inline;
}
a.hastyscribe-logo img {
  vertical-align: middle;
}
/* Checkboxes */
li.github_checkbox {
  list-style-type: none;
}
.note {
  background-clip: padding-box;
  border-radius: 3px;
  margin: 10px auto;
  padding: 2px 4px 0 4px;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  color: #264c72;
  background-color: #d8ebf8;
  border: 1px solid #A4D1EF;
  font-size: 95%;
}
.note code,
.note samp,
.note pre {
  color: #264c72;
}
.note a {
  color: #264c72;
}
.note p {
  margin: 0 auto;
}
@media screen and (min-width: 880px) {
  .note {
    margin-left: 80px;
    margin-right: 80px;
  }
}
.note > p {
  margin: 0 auto;
}
.note > p:first-child {
  font-weight: 700;
  color: #264c72;
}
.note pre,
.note code {
  color: #19324c;
}
.note a {
  color: #132639;
}
.tip {
  background-clip: padding-box;
  border-radius: 3px;
  margin: 10px auto;
  padding: 2px 4px 0 4px;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  color: #009926;
  background-color: #d8f5cd;
  border: 1px solid #B0EB99;
  font-size: 95%;
}
.tip code,
.tip samp,
.tip pre {
  color: #009926;
}
.tip a {
  color: #264c72;
}
.tip p {
  margin: 0 auto;
}
@media screen and (min-width: 880px) {
  .tip {
    margin-left: 80px;
    margin-right: 80px;
  }
}
.tip > p {
  margin: 0 auto;
}
.tip > p:first-child {
  font-weight: 700;
  color: #009926;
}
.tip pre,
.tip code {
  color: #006619;
}
.tip a {
  color: #004d13;
}
.warning {
  background-clip: padding-box;
  border-radius: 3px;
  margin: 10px auto;
  padding: 2px 4px 0 4px;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  color: #705400;
  background-color: #FFEBAD;
  border: 1px solid #FFDB70;
  font-size: 95%;
}
.warning code,
.warning samp,
.warning pre {
  color: #705400;
}
.warning a {
  color: #264c72;
}
.warning p {
  margin: 0 auto;
}
@media screen and (min-width: 880px) {
  .warning {
    margin-left: 80px;
    margin-right: 80px;
  }
}
.warning > p {
  margin: 0 auto;
}
.warning > p:first-child {
  font-weight: 700;
  color: #705400;
}
.warning pre,
.warning code {
  color: #3d2e00;
}
.warning a {
  color: #241b00;
}
.blank-sidebar {
  background-clip: padding-box;
  border-radius: 3px;
  margin: 10px auto;
  padding: 2px 4px 0 4px;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  color: #555;
  background-color: #fefefe;
  border: 1px solid #fefefe;
  font-size: 95%;
}
.blank-sidebar code,
.blank-sidebar samp,
.blank-sidebar pre {
  color: #555;
}
.blank-sidebar a {
  color: #264c72;
}
.blank-sidebar p {
  margin: 0 auto;
}
@media screen and (min-width: 880px) {
  .blank-sidebar {
    margin-left: 80px;
    margin-right: 80px;
  }
}
.blank-sidebar > p {
  margin: 0 auto;
}
.blank-sidebar > p:first-child {
  font-weight: 700;
  color: #555;
}
.blank-sidebar pre,
.blank-sidebar code {
  color: #3b3b3b;
}
.blank-sidebar a {
  color: #2f2f2f;
}
.sidebar {
  background-clip: padding-box;
  border-radius: 3px;
  margin: 10px auto;
  padding: 2px 4px 0 4px;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  color: #555;
  background-color: #f8f8f8;
  border: 1px solid #f8f8f8;
  font-size: 95%;
}
.sidebar code,
.sidebar samp,
.sidebar pre {
  color: #555;
}
.sidebar a {
  color: #264c72;
}
.sidebar p {
  margin: 0 auto;
}
@media screen and (min-width: 880px) {
  .sidebar {
    margin-left: 80px;
    margin-right: 80px;
  }
}
.sidebar > p {
  margin: 0 auto;
}
.sidebar > p:first-child {
  font-weight: 700;
  color: #555;
}
.sidebar pre,
.sidebar code {
  color: #3b3b3b;
}
.sidebar a {
  color: #2f2f2f;
}
.output {
  background-clip: padding-box;
  border-radius: 3px;
  margin: 10px auto;
  padding: 2px 4px 0 4px;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  color: #555;
  background-color: #f8f8f8;
  border: 1px solid #f8f8f8;
}
.output code,
.output samp,
.output pre {
  color: #555;
}
.output a {
  color: #264c72;
}
.output p {
  margin: 0 auto;
}
@media screen and (min-width: 880px) {
  .output {
    margin-left: 80px;
    margin-right: 80px;
  }
}
.terminal {
  background-clip: padding-box;
  border-radius: 3px;
  margin: 10px auto;
  padding: 2px 4px 0 4px;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  color: #eee;
  background-color: #222;
  border: 1px solid #ccc;
  hyphens: none;
  padding: 0 3px;
  border: 2px solid #999;
  white-space: pre-wrap;
  border-top: 10px solid #999;
}
.terminal code,
.terminal samp,
.terminal pre {
  color: #eee;
}
.terminal a {
  color: #264c72;
}
.terminal p {
  margin: 0 auto;
}
@media screen and (min-width: 880px) {
  .terminal {
    margin-left: 80px;
    margin-right: 80px;
  }
}
@media screen and (max-width: 639px) {
  .terminal {
    overflow-y: hidden;
    overflow-x: auto;
  }
  .terminal td {
    white-space: nowrap;
  }
}
.terminal > p,
.terminal > p:first-child {
  margin-top: -40px;
  margin-bottom: 0;
  text-shadow: none;
  font-weight: 400;
  font-family: monospace;
  font-size: 85%;
  color: #eee;
}
.terminal > p code,
.terminal > p:first-child code,
.terminal > p pre,
.terminal > p:first-child pre,
.terminal > p samp,
.terminal > p:first-child samp {
  font-size: 100%;
}
.terminal > p:first-child,
.terminal > p:first-child:first-child {
  margin-top: 0px;
}
.terminal > p:before,
.terminal > p:first-child:before {
  font-family: monospace;
  font-style: normal;
  font-weight: 700;
  color: #009926;
  content: "$ ";
}
.terminal-su {
  background-clip: padding-box;
  border-radius: 3px;
  margin: 10px auto;
  padding: 2px 4px 0 4px;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  color: #eee;
  background-color: #222;
  border: 1px solid #ccc;
  hyphens: none;
  padding: 0 3px;
  border: 2px solid #999;
  white-space: pre-wrap;
  border-top: 10px solid #999;
}
.terminal-su code,
.terminal-su samp,
.terminal-su pre {
  color: #eee;
}
.terminal-su a {
  color: #264c72;
}
.terminal-su p {
  margin: 0 auto;
}
@media screen and (min-width: 880px) {
  .terminal-su {
    margin-left: 80px;
    margin-right: 80px;
  }
}
@media screen and (max-width: 639px) {
  .terminal-su {
    overflow-y: hidden;
    overflow-x: auto;
  }
  .terminal-su td {
    white-space: nowrap;
  }
}
.terminal-su > p,
.terminal-su > p:first-child {
  margin-top: -40px;
  margin-bottom: 0;
  text-shadow: none;
  font-weight: 400;
  font-family: monospace;
  font-size: 85%;
  color: #eee;
}
.terminal-su > p code,
.terminal-su > p:first-child code,
.terminal-su > p pre,
.terminal-su > p:first-child pre,
.terminal-su > p samp,
.terminal-su > p:first-child samp {
  font-size: 100%;
}
.terminal-su > p:first-child,
.terminal-su > p:first-child:first-child {
  margin-top: 0px;
}
.terminal-su > p:before,
.terminal-su > p:first-child:before {
  font-family: monospace;
  font-style: normal;
  font-weight: 700;
  color: #009926;
  content: "$ ";
}
.terminal-su > p:before,
.terminal-su > p:first-child:before {
  color: #CC3300;
  content: "# ";
}
div .terminal {
  margin: 2px auto;
}
@media screen and (min-width: 880px) {
  div .terminal {
    margin-left: 80px;
    margin-right: 80px;
  }
}
details {
  font-size: 95%;
  background-clip: padding-box;
  border-radius: 3px;
  margin: 10px auto;
  padding: 2px 4px 0 4px;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.8);
  color: #555;
  background-color: #f8f8f8;
  border: 1px solid #fefefe;
  display: block;
}
details code,
details samp,
details pre {
  color: #555;
}
details a {
  color: #264c72;
}
details p {
  margin: 0 auto;
}
@media screen and (min-width: 880px) {
  details {
    margin-left: 80px;
    margin-right: 80px;
  }
}
details > summary::before {
  content: url("data:image/svg+xml,%3Csvg viewBox='0 0 448 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%23555555' d='M438.6 278.6c12.5-12.5 12.5-32.8 0-45.3l-160-160c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3L338.8 224 32 224c-17.7 0-32 14.3-32 32s14.3 32 32 32l306.7 0L233.4 393.4c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0l160-160z' /%3E %3C/svg%3E");
  display: inline-block;
  margin-right: 2px;
  vertical-align: text-top;
  height: 11px;
  width: 11px;
}
details[open] > summary::before {
  content: url("data:image/svg+xml,%3Csvg viewBox='0 0 384 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%23555555' d='M169.4 470.6c12.5 12.5 32.8 12.5 45.3 0l160-160c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L224 370.8 224 64c0-17.7-14.3-32-32-32s-32 14.3-32 32l0 306.7L54.6 265.4c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3l160 160z' /%3E %3C/svg%3E");
}
summary {
  cursor: pointer;
  font-weight: bold;
}
summary > * {
  display: inline;
}
.headings h1 {
  font-size: 2em;
}
.headings h2 {
  font-size: 1.5em;
  counter-reset: h3;
  counter-increment: h2;
}
.headings h2::before {
  content: counter(h2) "\00A0\00A0";
}
.headings h3 {
  font-size: 1.2em;
  counter-reset: h4;
  counter-increment: h3;
}
.headings h3::before {
  content: counter(h2) "." counter(h3) "\00A0\00A0";
}
.headings h4 {
  font-size: 1.1em;
  counter-reset: h5;
  counter-increment: h4;
}
.headings h4::before {
  content: counter(h2) "." counter(h3) "." counter(h4) "\00A0\00A0";
}
.headings h5 {
  font-size: 1em;
  counter-reset: h6;
  counter-increment: h5;
}
.headings h5::before {
  content: counter(h2) "." counter(h3) "." counter(h4) "." counter(h5) "\00A0\00A0";
}
.headings h6 {
  font-size: 1em;
  counter-increment: h6;
}
.headings h6::before {
  content: counter(h2) "." counter(h3) "." counter(h4) "." counter(h5) "." counter(h6) "\00A0\00A0";
}
/***************/
.headings #toc {
  counter-reset: toc2;
}
#toc > ul > li > ul > li > a {
  font-weight: 700;
}
.headings #toc li li a {
  counter-reset: toc3;
  counter-increment: toc2;
}
.headings #toc li li a::before {
  content: counter(toc2) "\00A0\00A0";
}
.headings #toc li li li a {
  counter-reset: toc4;
  counter-increment: toc3;
}
.headings #toc li li li a::before {
  content: counter(toc2) "." counter(toc3) "\00A0\00A0";
}
.headings #toc li li li li a {
  counter-reset: toc5;
  counter-increment: toc4;
}
.headings #toc li li li li a::before {
  content: counter(toc2) "." counter(toc3) "." counter(toc4) "\00A0\00A0";
}
.headings #toc li li li li li a {
  counter-reset: toc6;
  counter-increment: toc5;
}
.headings #toc li li li li li a::before {
  content: counter(toc2) "." counter(toc3) "." counter(toc4) "." counter(toc5) "\00A0\00A0";
}
.headings #toc li li li li li li a {
  counter-increment: toc6;
}
.headings #toc li li li li li li a::before {
  content: counter(toc2) "." counter(toc3) "." counter(toc4) "." counter(toc5) "." counter(toc6) "\00A0\00A0";
}
@media print {
  body {
    width: 700px;
  }
  /* Table of Contents */
  #toc {
    width: 650px;
    list-style-type: none;
  }
  #toc ul {
    list-style-type: none;
    padding-left: 20px;
    margin-left: 0;
  }
  #toc li {
    padding-left: 0;
    margin-left: 0;
    padding-bottom: 0.2em;
  }
  #toc a {
    text-decoration: none;
  }
  #toc a::after {
    content: leader(".") target-counter(attr(href), page);
  }
  #toc a[href="#preface"]::after {
    content: leader(".") target-counter(attr(href), page, lower-roman);
  }
  #toc a {
    color: #000;
  }
  #toc > li {
    margin: 0.2em 0;
    line-height: 1.2em;
    font-weight: bold;
    padding-bottom: 0.4em;
    font-size: 110%;
  }
  #toc > li > ul > li {
    font-weight: normal;
    font-size: 100%;
  }
  #toc li li li li li li {
    display: none;
    /* None sane of mind would EVER want more than five TOC levels. */
  }
  #toc > li {
    counter-increment: toc1;
    counter-reset: toc2;
  }
  #toc > li > a::before {
    content: counter(toc1) " ";
  }
  #toc > li > a[href="#preface"]::before {
    counter-reset: toc1;
    content: "";
  }
  #toc > li > ul > li {
    counter-increment: toc2;
    counter-reset: toc3;
  }
  #toc > li > ul > li > a::before {
    content: counter(toc1) "." counter(toc2) " ";
  }
  #toc > li > ul > li > ul > li {
    counter-increment: toc3;
    counter-reset: toc4;
  }
  #toc > li > ul > li > ul > li > a::before {
    content: counter(toc1) "." counter(toc2) "." counter(toc3) " ";
  }
  #toc > li > ul > li > ul > li > ul > li {
    counter-increment: toc4;
    counter-reset: toc5;
  }
  #toc > li > ul > li > ul > li > ul > li > a::before {
    content: counter(toc1) "." counter(toc2) "." counter(toc3) "." counter(toc4) " ";
  }
  #toc > li > ul > li > ul > li > ul > li > ul > li {
    counter-increment: toc5;
    counter-reset: toc6;
  }
  #toc > li > ul > li > ul > li > ul > li > ul > li > a::before {
    content: counter(toc1) "." counter(toc2) "." counter(toc3) "." counter(toc4) "." counter(toc5) " ";
  }
  a[href="#document-top"] {
    display: none;
  }
  h1 {
    margin-bottom: 50px;
    border-bottom: 0;
  }
  h2 {
    margin-bottom: 30px;
    page-break-before: always;
    border-bottom: 0;
  }
  h2,
  h3,
  h4,
  h5,
  h6 {
    page-break-after: avoid;
  }
  @page {
    size: A4;
    margin: 50pt 30pt 50pt 30pt;
    padding-top: 20pt;
    @bottom-right {
      content: counter(page);
      font-family: 'sans-serif';
      font-size: 0.8em;
    }
  }
}
</style>
  <style>.note > p:first-child:before { background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 384 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%23264c72' d='M32 32C32 14.3 46.3 0 64 0H320c17.7 0 32 14.3 32 32s-14.3 32-32 32H290.5l11.4 148.2c36.7 19.9 65.7 53.2 79.5 94.7l1 3c3.3 9.8 1.6 20.5-4.4 28.8s-15.7 13.3-26 13.3H32c-10.3 0-19.9-4.9-26-13.3s-7.7-19.1-4.4-28.8l1-3c13.8-41.5 42.8-74.8 79.5-94.7L93.5 64H64C46.3 64 32 49.7 32 32zM160 384h64v96c0 17.7-14.3 32-32 32s-32-14.3-32-32V384z' /%3E %3C/svg%3E") }
.sidebar > p:first-child:before { background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 512 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%23555555' d='M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z' /%3E %3C/svg%3E") }
.tip > p:first-child:before { background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 512 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%23009926' d='M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z' /%3E %3C/svg%3E") }
.note > p:first-child:before { background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 384 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%23264c72' d='M32 32C32 14.3 46.3 0 64 0H320c17.7 0 32 14.3 32 32s-14.3 32-32 32H290.5l11.4 148.2c36.7 19.9 65.7 53.2 79.5 94.7l1 3c3.3 9.8 1.6 20.5-4.4 28.8s-15.7 13.3-26 13.3H32c-10.3 0-19.9-4.9-26-13.3s-7.7-19.1-4.4-28.8l1-3c13.8-41.5 42.8-74.8 79.5-94.7L93.5 64H64C46.3 64 32 49.7 32 32zM160 384h64v96c0 17.7-14.3 32-32 32s-32-14.3-32-32V384z' /%3E %3C/svg%3E") }
.sidebar > p:first-child:before { background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 512 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%23555555' d='M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z' /%3E %3C/svg%3E") }a[href^='#document-top']:before { background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 448 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%234183c4' d='M246.6 41.4c-12.5-12.5-32.8-12.5-45.3 0l-160 160c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0L224 109.3 361.4 246.6c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3l-160-160zm160 352l-160-160c-12.5-12.5-32.8-12.5-45.3 0l-160 160c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0L224 301.3 361.4 438.6c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3z' /%3E %3C/svg%3E") }
a[href^='http']:before { background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 512 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%234183c4' d='M352 256c0 22.2-1.2 43.6-3.3 64H163.3c-2.2-20.4-3.3-41.8-3.3-64s1.2-43.6 3.3-64H348.7c2.2 20.4 3.3 41.8 3.3 64zm28.8-64H503.9c5.3 20.5 8.1 41.9 8.1 64s-2.8 43.5-8.1 64H380.8c2.1-20.6 3.2-42 3.2-64s-1.1-43.4-3.2-64zm112.6-32H376.7c-10-63.9-29.8-117.4-55.3-151.6c78.3 20.7 142 77.5 171.9 151.6zm-149.1 0H167.7c6.1-36.4 15.5-68.6 27-94.7c10.5-23.6 22.2-40.7 33.5-51.5C239.4 3.2 248.7 0 256 0s16.6 3.2 27.8 13.8c11.3 10.8 23 27.9 33.5 51.5c11.6 26 20.9 58.2 27 94.7zm-209 0H18.6C48.6 85.9 112.2 29.1 190.6 8.4C165.1 42.6 145.3 96.1 135.3 160zM8.1 192H131.2c-2.1 20.6-3.2 42-3.2 64s1.1 43.4 3.2 64H8.1C2.8 299.5 0 278.1 0 256s2.8-43.5 8.1-64zM194.7 446.6c-11.6-26-20.9-58.2-27-94.6H344.3c-6.1 36.4-15.5 68.6-27 94.6c-10.5 23.6-22.2 40.7-33.5 51.5C272.6 508.8 263.3 512 256 512s-16.6-3.2-27.8-13.8c-11.3-10.8-23-27.9-33.5-51.5zM135.3 352c10 63.9 29.8 117.4 55.3 151.6C112.2 482.9 48.6 426.1 18.6 352H135.3zm358.1 0c-30 74.1-93.6 130.9-171.9 151.6c25.5-34.2 45.2-87.7 55.3-151.6H493.4z' /%3E %3C/svg%3E") }
a[href*='github.com']:before { background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 496 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%234183c4' d='M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z' /%3E %3C/svg%3E") }
a[href$='.zip']:before { background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 384 512' xmlns='http://www.w3.org/2000/svg'%3E %3Cpath fill='%234183c4' d='M64 0C28.7 0 0 28.7 0 64V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V160H256c-17.7 0-32-14.3-32-32V0H64zM256 0V128H384L256 0zM96 48c0-8.8 7.2-16 16-16h32c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16zm0 64c0-8.8 7.2-16 16-16h32c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16zm0 64c0-8.8 7.2-16 16-16h32c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16zm-6.3 71.8c3.7-14 16.4-23.8 30.9-23.8h14.8c14.5 0 27.2 9.7 30.9 23.8l23.5 88.2c1.4 5.4 2.1 10.9 2.1 16.4c0 35.2-28.8 63.7-64 63.7s-64-28.5-64-63.7c0-5.5 .7-11.1 2.1-16.4l23.5-88.2zM112 336c-8.8 0-16 7.2-16 16s7.2 16 16 16h32c8.8 0 16-7.2 16-16s-7.2-16-16-16H112z' /%3E %3C/svg%3E") }</style>
  
  
  
</head>
<body class="headings">
  <div id="container">
    <a id="document-top"></a>
    <div id="header"><h1>pls User Guide</h1></div>
    <div id="toc"><ul>
 <li>
 <ul>
  <li><a href="#Overview">Overview</a>
  <ul>
   <li><a href="#Main-Features">Main Features</a></li>
   <li><a href="#Hello,-World!">Hello, World!</a></li>
   <li><a href="#Key-Concepts">Key Concepts</a>
   <ul>
    <li><a href="#Shell-Command">Shell Command</a></li>
    <li><a href="#Command">Command</a></li>
    <li><a href="#Action">Action</a></li>
    <li><a href="#Thing">Thing</a></li>
    <li><a href="#Property">Property</a></li>
    <li><a href="#Action-Definition">Action Definition</a></li>
    <li><a href="#Dependency">Dependency</a></li>
    <li><a href="#Placeholder">Placeholder</a>
</li>
   </ul>
   </li>
  </ul>
  </li>
  <li><a href="#Getting-Started">Getting Started</a>
  <ul>
   <li><a href="#Downloading-Pre-built-Binaries">Downloading Pre-built Binaries</a></li>
   <li><a href="#Building-from-Source">Building from Source</a></li>
  </ul>
  </li>
  <li><a href="#Using-<em>pls</em>">Using <em>pls</em></a>
  <ul>
   <li><a href="#Configuring-<em>pls</em>">Configuring <em>pls</em></a>
   <ul>
    <li><a href="#Configuring-<em>things</em>">Configuring <em>things</em></a></li>
    <li><a href="#Configuring-<em>actions</em>">Configuring <em>actions</em></a></li>
    <li><a href="#Configuring-<em>dependencies</em>">Configuring <em>dependencies</em></a></li>
   </ul>
   </li>
   <li><a href="#Executing-<em>commands</em>">Executing <em>commands</em></a></li>
   <li><a href="#Inspecting-<em>commands</em>">Inspecting <em>commands</em></a></li>
   <li><a href="#Displaying-<em>actions</em>,-<em>things</em>,-and-<em>things</em>">Displaying <em>actions</em>, <em>things</em>, and <em>things</em></a></li>
  </ul>
  </li>
  <li><a href="#The-<em>pls</em>-Configuration-YAML-Schema">The <em>pls</em> Configuration YAML Schema</a></li>
 </ul>
 </li>
</ul>
</div>
    <div id="main">
<a id="Overview"></a>
<h2>Overview<a href="#document-top" title="Go to top"></a></h2>

<p><em>pls</em> is a simple, general-purpose task runner that aims at making common tasks easier to manage and execute. It was inspired by some of the functionalities provided by the <a href="https://h3rald.com/nifty">nifty</a> package manager, only without the package manager part.</p>

<a id="Main-Features"></a>
<h3>Main Features<a href="#document-top" title="Go to top"></a></h3>

<p><em>pls</em> can be used to:</p>

<ul>
<li>Define a catalog of <em>actions</em> to perform on <em>things</em>, which will result in <em>commands</em> to be executed, each with the same simple syntax.</li>
<li>Define a catalog of <em>things</em>, representing virtually anything that can be the object of a <em>shell command</em> or referred within other <em>things</em>.</li>
<li>Define a set of <em>dependencies</em> among <em>commands</em>, in the form of <em>commands</em>.</li>
<li>Manage aliases to commonly-used strings (<em>properties</em>) to use within other sections of the configuration.</li>
</ul>


<a id="Hello,-World!"></a>
<h3>Hello, World!<a href="#document-top" title="Go to top"></a></h3>

<p>Here&rsquo;s minimal but quite comprehensive example of how everything works with <em>pls</em>. Given the following <span class="file">pls.yml</span> file (placed in <var>$HOME</var> or in <var>%USERPROFILE%</var> on Windows):</p>

<pre><code>things:
  home:
    value: /home/h3rald
  bin:
    value: {{home.value}}/bin
  self:
    value: {{home.value}}/dev/pls
    exe: pls
    nimble: true
actions:
  build:
    nimble+value: cd {{value}} &amp;&amp; nimble build -d:release
  publish:
    exe+value: cd {{value}} &amp;&amp; $(cp "{{exe}}" "{{bin.value}}") &amp;
deps:
  publish self:
    - build self
</code></pre>

<p>It will be possible to run the following <em>command</em> to build the <em>pls</em> program itself and copy it to the <span class="dir">/home/h3rald/bin</span>:</p>

<div class="terminal"><p>pls publish self</p></div>

<a id="Key-Concepts"></a>
<h3>Key Concepts<a href="#document-top" title="Go to top"></a></h3>

<p><em>pls</em> is based on a few intuitive abstractions that are used for its configuration, as described in the following sections.</p>

<a id="Shell-Command"></a>
<h4>Shell Command<a href="#document-top" title="Go to top"></a></h4>

<p>A <em>shell command</em> is simply a string that can be passed to the underlying system shell to be executed.</p>

<a id="Command"></a>
<h4>Command<a href="#document-top" title="Go to top"></a></h4>

<p>A <em>command</em> is an instruction given to <em>pls</em> to execute a <em>shell command</em>. The syntax of a <em>command</em> is always the following:</p>

<p><em>action-identifier</em> <em>thing-identifier-1</em> [&hellip; <em>thing-identifier-n</em>]</p>

<div class="note"><p><em>pls</em> Commands vs. Shell Commands</p>

<p>The word <em>command</em> identifies a <em>pls</em> command, while a command executed by the underlying operating system shell is referred to as a <em>shell command</em>.</p></div>

<a id="Action"></a>
<h4>Action<a href="#document-top" title="Go to top"></a></h4>

<p>An <em>action</em> identifies something that can be done with one or more <em>things</em>. Depending on the <em>thing</em> specified, the <em>action</em> can be configured to execute a different <em>shell command</em>.</p>

<a id="Thing"></a>
<h4>Thing<a href="#document-top" title="Go to top"></a></h4>

<p>A <em>thing</em> identifies something that can be referenced by an <em>action</em>. There is virtually no restriction on what a <em>thing</em> may represent: it can be a folder, a file, the name of a running process or service, and so on.</p>

<a id="Property"></a>
<h4>Property<a href="#document-top" title="Go to top"></a></h4>

<p>A <em>property</em> identifies a trait of a <em>thing</em>. It can be a simple flag or an attribute defining something about a <em>thing</em> that can be used as part of the identifier of an <em>action definition</em> or referenced via a <em>placeholder</em> in <em>action definitions</em> and other <em>property</em> values.</p>

<a id="Action-Definition"></a>
<h4>Action Definition<a href="#document-top" title="Go to top"></a></h4>

<p>An <em>action definition</em> is defined by an identifier composed by plus-separated <em>properties</em> (e.g.: git+folder+value), and determines what <em>shell command</em> to execute when a <em>command</em> is run.</p>

<a id="Dependency"></a>
<h4>Dependency<a href="#document-top" title="Go to top"></a></h4>

<p>A <em>dependency</em> identifies a <em>command</em> that must be executed before another <em>command</em>. If the <em>shell command</em> executed as a dependency fails, no more <em>dependencies</em> will be executed and neither will the <em>command</em> with the <em>dependencies</em>.</p>

<a id="Placeholder"></a>
<h4>Placeholder<a href="#document-top" title="Go to top"></a></h4>

<p>A <em>placeholder</em> is a reference to a <em>property</em> wrapped in double curly brackets that can be used in <em>property</em> values or shell commands.</p>

<a id="Getting-Started"></a>
<h2>Getting Started<a href="#document-top" title="Go to top"></a></h2>

<a id="Downloading-Pre-built-Binaries"></a>
<h3>Downloading Pre-built Binaries<a href="#document-top" title="Go to top"></a></h3>

<p>The easiest way to get <em>pls</em> is by downloading one of the prebuilt binaries from the <a href="https://github.com/h3rald/pls/releases">Github Releases Page</a>:</p>

<ul>
<li><a href="https://github.com/h3rald/pls/releases/dowload/1.0.0/pls_v1.0.0_macosx_x64.zip">pls for Mac OS X (x64)</a></li>
<li><a href="https://github.com/h3rald/pls/releases/dowload/1.0.0/pls_v1.0.0_windows_x64.zip">pls for Windows (x64)</a></li>
<li><a href="https://github.com/h3rald/pls/releases/dowload/1.0.0/pls_v1.0.0_linux_x64.zip">pls for Linux (x64)</a></li>
</ul>


<a id="Building-from-Source"></a>
<h3>Building from Source<a href="#document-top" title="Go to top"></a></h3>

<p>You can also build <em>pls</em> from source, if there is no pre-built binary for your platform.</p>

<p>To do so, after installing the <a href="https://nim-lang.org">Nim</a> programming language, you can:</p>

<ol>
<li>Clone the pls <a href="https://github.com/h3rald/pls">repository</a>.</li>
<li>Navigate to the <span class="dir">pls</span> repository local folder.</li>
<li>Run <strong>nimble build -d:release</strong></li>
</ol>


<a id="Using-<em>pls</em>"></a>
<h2>Using <em>pls</em><a href="#document-top" title="Go to top"></a></h2>

<p>The first time you run <em>pls</em>, a <span class="file">pls.yml</span> configuration file will be created in your <var>$HOME</var> (<var>%USERPROFILE%</var> on Windows) folder. This YAML configuration file will teach <em>pls</em> everything it needs to know to execute <em>commands</em> and it will be parsed and processed every time <em>pls</em> is executed.</p>

<a id="Configuring-<em>pls</em>"></a>
<h3>Configuring <em>pls</em><a href="#document-top" title="Go to top"></a></h3>

<p>The <span class="file">pls.yml</span> file contains three sections:</p>

<ul>
<li><strong>actions</strong>, where each <em>action</em> is defined.</li>
<li><strong>things</strong>, where each <em>thing</em> is defined.</li>
<li><strong>deps</strong>, where each <em>dependency</em> is defined.</li>
</ul>


<p>Consider the following sample <span class="file">pls.yml</span> file:</p>

<p><a id="cfg-example"></a></p>

<pre><code>things:
  home:
    value: /home/h3rald
  dev:
    value: {{home.value}}/dev
  bin:
    value: {{home.value}}/bin
  h3:
    value: {{home.dev}}/h3
    npm: true
  self:
    value: {{home.dev}}/{{exe}}
    conf: {{home.value}}/{{exe}}.yml
    exe: pls
    nimble: true
actions:
  config:
    conf: vim "{{conf}}"
  edit:
    value: vim "{{value}}"
  publish:
    exe+value: cd "{{value}}" &amp;&amp; $(cp "{{exe}}" "{{bin.value}}") &amp;
  build:
    npm+value: cd "{{value}}" &amp;&amp; npm run build
    nimble+value: cd "{{value}}" &amp;&amp; nimble build -d:release
deps:
  publish self:
    - build self
</code></pre>

<p>This configuration file should give you an idea of how to configure <em>pls</em> to execute your own custom <em>commands</em>. In this case, it is possible to execute <em>commands</em> like:</p>

<ul>
<li>pls publish self</li>
<li>pls config self</li>
<li>pls edit h3</li>
<li>pls build self h3</li>
</ul>


<p>&hellip;and so on. Let&rsquo;s see how to configure each section more in detail.</p>

<a id="Configuring-<em>things</em>"></a>
<h4>Configuring <em>things</em><a href="#document-top" title="Go to top"></a></h4>

<p>Keep in mind that a <em>thing</em> is going to be used as the object or target of your <em>action</em>, so it typically should represent a file, a folder, a URL, a service name, and so on. Also, it makes sense to define new <em>things</em> if they are going to be used often in actions or referenced in other <em>things</em>. In relation to the <a href="#cfg-example">configuration example</a>, note how the <span class="kwd">home</span> <em>thing</em> is re-used in <span class="kwd">dev</span> and <span class="kwd">bin</span>.</p>

<p>A <em>thing</em> is defined by one or more arbitrary <em>properties</em>. There are virtually no restrictions on what these <em>properties</em> can represent, but they must fit on one line and they will always be parsed as strings, no matter what the highlighting of your <span class="file">pls.yml</span> says. Typically, it makes sense to define a <span class="kwd">value</span> <em>property</em> for the <em>property</em> that most characterizes the <em>thing</em>, but this is merely a convention, nothing more.</p>

<p>Any <em>property</em> of any <em>thing</em> can be reused via a <em>placeholder</em>:</p>

<ul>
<li>in <em>actions</em></li>
<li>in other <em>things</em></li>
</ul>


<div class="sidebar"><p>Relative vs. Absolute Placeholders</p>

<p>Properties of <em>things</em> can be referenced using a relative <em>placeholder</em> specifying just the identified of the referenced <em>property</em> (e.g. <span class="kwd">{{value}}</span>) when used within a <em>property</em> of the same <em>thing</em> or (within an <em>action</em>) when referring to the <em>thing</em> matched by an <em>action</em>.</p>

<p>Otherwise, you can use absolute <em>placeholders</em> by prepanding the name of the <em>thing</em> followed by a dot, and then the <em>property</em> identifier, e.g. <span class="kwd">{{home.value}}</span>.</p></div>

<a id="Configuring-<em>actions</em>"></a>
<h4>Configuring <em>actions</em><a href="#document-top" title="Go to top"></a></h4>

<p>While <em>property</em> identifiers are just straightforward names, <em>actions</em> are identified by a combination of plus-separated <em>property</em> identifiers. Each <em>action</em> can have one or more <em>action definitions</em>, each specifying a different set of <em>property</em> identifiers.</p>

<p>When an action is executed on one or more <em>things</em>, <em>pls</em> will try to match the appropriate <em>action definition</em> based on the <em>properties</em> specified in the <em>action definition</em>. Consider the <span class="kwd">build</span> <em>action</em> in the <a href="#cfg-example">configuration example</a>; it is possible to run the following <em>commands</em>:</p>

<div class="terminal"><p>pls build self</p></div>

<p>which will result in <span class="cmd">cd /home/h3rald/dev/pls &amp;&amp; nimble build -d:release</span> being executed, and:</p>

<div class="terminal"><p>pls build h3</p></div>

<p>which will result in <span class="cmd">cd /home/h3rald/dev/h3 &amp;&amp; npm run build</span>.</p>

<p>Note how a different <em>action definition</em> is triggered depending on the <em>properties</em> of the specified <em>thing</em>. If however you try running the following <em>command</em>:</p>

<div class="terminal"><p>pls build home</p></div>

<p>nothing will happen, as there is no matching <em>action definition</em> for <span class="kwd">home</span>, which only contains a <span class="kwd">value</span> <em>property</em>.</p>

<div class="tip"><p>Tip</p>

<p>If several <em>action definitions</em> match for the specified <em>thing</em>, the one with the most matching <em>properties</em> will be used.</p></div>

<a id="Configuring-<em>dependencies</em>"></a>
<h4>Configuring <em>dependencies</em><a href="#document-top" title="Go to top"></a></h4>

<p>You can use the <span class="kwd">dependencies</span> section to configure <em>dependencies</em> among commands. Essentially, for each <em>command</em> (comprised of an <em>action</em> followed by one or more <em>thing</em>), you can specify a list comprised of one or more <em>commands</em> that will be executed beforehand.</p>

<p>In the <a href="#cfg-example">configuration example</a>, executing:</p>

<div class="terminal"><p>pls publish self</p></div>

<p>will cause the <span class="cmd">build self</span> <em>command</em> to be executed beforehand.</p>

<div class="note"><p>Command execution and dependencies</p>

<p>If <em>dependencies</em> are specified for a <em>command</em>:</p>

<ul>
<li>all its <em>dependencies</em> are executed sequentially before the <em>command</em> is executed</li>
<li>if one dependent <em>command</em> fails, no more <em>dependencies</em> will be executed, and the <em>command</em> will not be executed</li>
</ul>
</div>

<a id="Executing-<em>commands</em>"></a>
<h3>Executing <em>commands</em><a href="#document-top" title="Go to top"></a></h3>

<p>The previous sections already contain a few examples on how to run <em>commands</em> with <em>pls</em>. Essentially, the syntax is always the same:</p>

<p><span class="cmd">pls <em>action</em> <em>thing-1</em> [&hellip;<em>thing-n</em>]</span></p>

<p>So, for example:</p>

<div class="terminal"><p>pls config self</p></div>

<p>will execute the <span class="kwd">config</span> <em>action</em> on the <span class="kwd">self</span> <em>thing</em>, and:</p>

<div class="terminal"><p>pls build self h3</p></div>

<p>will execute execute the <span class="kwd">build</span> <em>action</em> on the <span class="kwd">self</span> <em>thing</em>, and then on the <span class="kwd">h3</span> <em>thing</em>.</p>

<p>There are no built-in <em>commands</em>, so the first argument specified after <em>pls</em> is interpreted as an <em>action</em>, and the following ones as things. If no things are specified, an error will be printed.</p>

<a id="Inspecting-<em>commands</em>"></a>
<h3>Inspecting <em>commands</em><a href="#document-top" title="Go to top"></a></h3>

<p>If you want to see what <em>shell commands</em> a particular <em>command</em> will execute, or how certain <em>thing</em> properties will be matched or used, you can specify the <span class="arg">-i</span> (<span class="arg">--inspect</span>) option to print some diagnostic messages and the resulting shell <em>commands</em>, without executing them:</p>

<div class="terminal"><p>pls build self -i
. Command: build self
. Thing: self
. -> Matching Definition: nimble+value
. -> Command Definition: cd {{value}} &amp;&amp; nimble build
. Resolving placeholder: {{home.value}} -> /home/h3rald
. Resolving placeholder: {{dev.value}} -> /home/h3rald/dev
. Resolving placeholder: {{self.value}} -> /home/h3rald/dev/pls
. -> Resolved Command: cd /home/h3rald/dev/pls &amp;&amp; nimble build -d:release</p></div>

<div class="sidebar"><p>Using the <span class="arg">-f</span> (<span class="arg">--full</span>) option</p>

<p>If you specify the <span class="arg">-f</span> together with the <span class="arg">-i</span> option, additional messages will be printed related to the processing of the <span class="file">pls.yml</span> file.
If you specify only the <span class="arg">-f</span> when executing a <em>command</em>, the resulting <em>shell command</em> will be printed before being executed.</p></div>

<a id="Displaying-<em>actions</em>,-<em>things</em>,-and-<em>things</em>"></a>
<h3>Displaying <em>actions</em>, <em>things</em>, and <em>things</em><a href="#document-top" title="Go to top"></a></h3>

<p>If you want to quickly display the <em>actions</em>, <em>things</em> or <em>dependencies</em> that are available without opening the <span class="file">pls.yml</span> file, you can use the <span class="arg">-a</span> (<span class="arg">--actions</span>), <span class="arg">-t</span> (<span class="arg">--things</span>), and <span class="arg">-d</span> (<span class="arg">--deps</span>) respectively. Unless the <span class="arg">-f</span> (<span class="arg">--full</span>) option is specified as well, a simply list of <em>actions</em>, <em>things</em>, or <em>dependencies</em> will be displayed.</p>

<p>If you specify the <span class="arg">-f</span> (<span class="arg">--full</span>) option as well:</p>

<ul>
<li><em>action definitions</em> will be displayed for each <em>action</em></li>
<li><em>properties</em> will be displayed for each <em>thing</em></li>
<li>dependent <em>commands</em> will be displayed for each <em>dependency</em></li>
</ul>


<a id="The-<em>pls</em>-Configuration-YAML-Schema"></a>
<h2>The <em>pls</em> Configuration YAML Schema<a href="#document-top" title="Go to top"></a></h2>

<p>The following schema is based on the <a href="https://asdf-standard.readthedocs.io/en/latest/schemas/yaml_schema.html#yaml-schema-draft-01">YAML Schema</a> extension of <a href="http://json-schema.org/draft-04/json-schema-validation.html">JSON Schema Draft 4</a> and describes the configuration of <span class="file">pls.yml</span> files.</p>

<pre><code>%YAML 1.1
---
$schema: https://h3rald.com/pls/yaml-schema/v1.0.0
id: https://h3rald.com/schemas/pls/metadata-1.0.0
tag: tag:h3rald.com:pls/metadata-1.0.0
title: pls Configuration File
type: object
  properties:
    things:
      type: object
      patternProperties:
        ^[a-z0-9][a-zA-Z0-9_-]+$:
          $ref: #/$defs/thing
    actions:
      type: object
      patternProperties:
        ^[a-z0-9][a-zA-Z0-9_-]+$:
          $ref: #/$defs/action
    deps:
      type: object
      patternProperties:
        ^[a-z0-9][a-zA-Z0-9_-]+)( [a-z0-9][a-zA-Z0-9_-]+)+$:
          $ref: #/$defs/dependencies
required: [things, actions]
additionalProperties: false
$defs:
  thing:
    type: object
    patternProperties:
      ^[a-z0-9][a-zA-Z0-9_-]+$: string
  action:
    type: object
    patternProperties:
      ^[a-z0-9][a-zA-Z0-9_-]+(\+[a-z0-9][a-zA-Z0-9_-]+)*$: string
  dependencies:
    type: array
    items:
      type:
        $ref: #/$defs/command
  command:
    type: string
    pattern: |
      ^[a-z0-9][a-zA-Z0-9_-]+( [a-z0-9][a-zA-Z0-9_-]+)+$
</code></pre>
    </div>
    <div id="footer">
      <p><span class="copy"></span> Fabio Cevasco &ndash; September 1, 2023</p>
      <p><span>Powered by</span> <a href="https://h3rald.com/hastyscribe" class="hastyscribe-logo">  <img src="data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20width='350.755'%20height='102.312'%3E%3Cg%20font-family='Mr%20Bedfort'%20font-size='72'%20font-weight='400'%20letter-spacing='0'%20style='line-height:125%25;-inkscape-font-specification:Mr%20Bedfort'%20word-spacing='0'%3E%3Cpath%20d='m17.352%2044.784-1.296-5.616c-3.552-1.2-7.2-2.52-10.944-3.96-.048%200-.072.024-.072.072.048%201.008%204.152%204.176%2012.312%209.504m6.12-3.24c.96%204.224%201.56%206.96%201.8%208.208%2011.424%206.96%2018.744%2010.464%2021.96%2010.512l-3.888-13.896c-6.432-1.248-13.056-2.856-19.872-4.824M18%204.752l-.288%204.608c0%204.464%201.512%2013.32%204.536%2026.568%206.24%201.92%2012.792%203.576%2019.656%204.968-1.968-7.44-3.408-13.848-4.32-19.224-.912-5.424-1.368-11.208-1.368-17.352.096-.528%201.032-1.368%202.808-2.52C40.848.6%2042.144%200%2042.912%200c.384%200%20.576.264.576.792l-.36%205.04c0%207.776%202.016%2019.872%206.048%2036.288%205.664.864%2010.944%201.368%2015.84%201.512.336%200%20.504.168.504.504%200%20.288-1.056%201.008-3.168%202.16-2.112%201.152-3.36%201.728-3.744%201.728-2.256%200-4.944-.192-8.064-.576l2.808%2010.08c0%20.816-1.704%202.208-5.112%204.176-3.84%200-11.376-3.336-22.608-10.008.48%202.688.768%205.04.864%207.056-.096.096-1.056.576-2.88%201.44-1.824.864-2.856%201.296-3.096%201.296-.624%200-.936-.456-.936-1.368-.432-4.56-1.056-9-1.872-13.32-4.896-3.168-9.072-6.048-12.528-8.64C1.728%2035.52%200%2033.912%200%2033.336c0-.768%201.584-2.088%204.752-3.96l.216-.144c3.264%201.536%206.48%202.88%209.648%204.032-2.736-10.416-4.104-17.496-4.104-21.24%200-1.68.192-3%20.576-3.96.096-.144%201.152-.816%203.168-2.016%202.016-1.2%203.168-1.8%203.456-1.8.192%200%20.288.168.288.504M78.01%2040.104c.144-.288%201.44-.432%203.888-.432%202.496%200%203.744.36%203.744%201.08%200%20.144-.144.432-.432.864-1.68%202.304-2.52%204.704-2.52%207.2%200%202.496.576%204.56%201.728%206.192%201.2%201.584%202.712%202.376%204.536%202.376%202.976%200%206-2.112%209.072-6.336l.504.864c-3.744%205.952-7.872%208.928-12.384%208.928-3.408%200-6.024-1.752-7.848-5.256-.768%201.152-2.016%202.232-3.744%203.24-1.728%201.008-3.36%201.512-4.896%201.512-4.176%200-6.264-1.752-6.264-5.256%200-2.736%201.152-5.592%203.456-8.568%202.352-3.024%204.656-4.536%206.912-4.536.192%200%20.288.072.288.216%200%20.144-.096.312-.288.504-1.008.528-1.872%201.632-2.592%203.312a13.12%2013.12%200%200%200-1.008%205.04c0%203.504%201.344%205.256%204.032%205.256.768%200%201.488-.192%202.16-.576.72-.432%201.152-1.032%201.296-1.8a14.973%2014.973%200%200%201-.936-5.256c0-1.824.072-3.36.216-4.608.384-2.64.744-3.96%201.08-3.96'/%3E%3Cpath%20d='m119.772%2051.048.504.864c-2.016%203.216-4.44%205.664-7.272%207.344-2.832%201.728-5.52%202.592-8.064%202.592-5.136%200-8.544-2.208-10.224-6.624%200-.24.552-1.032%201.656-2.376%201.104-1.344%201.824-2.016%202.16-2.016.384%200%20.6.12.648.36.288%201.536%201.08%203.168%202.376%204.896%201.344%201.728%202.568%202.592%203.672%202.592%201.728%200%202.616-.48%202.664-1.44%200-1.488-1.752-3.744-5.256-6.768-1.296-1.152-2.496-2.616-3.6-4.392-1.056-1.824-1.584-3.696-1.584-5.616%200-.384.072-.648.216-.792%202.112-1.92%203.504-2.88%204.176-2.88.528%200%20.792.408.792%201.224.048%201.776.792%203.624%202.232%205.544%201.488%201.872%202.928%203.672%204.32%205.4%201.44%201.728%202.16%203.456%202.16%205.184%200%201.68-.84%203.192-2.52%204.536%203.936-.096%207.584-2.64%2010.944-7.632'/%3E%3Cpath%20d='M122.633%2024.264c.768%2022.56%204.248%2033.84%2010.44%2033.84%202.64%200%205.808-2.352%209.504-7.056l.504.864c-4.512%206.72-8.832%2010.08-12.96%2010.08-4.08%200-7.392-3.12-9.936-9.36-2.544-6.288-3.888-14.64-4.032-25.056%200%200-.347-5.071%200-4.827.096-3.648.264-5.229.504-8.493%200-.432.216-.72.648-.864%202.88-1.152%204.488-1.728%204.824-1.728.384%200%20.576.216.576.648a165.13%20165.13%200%200%200-.144%206.552'/%3E%3Cpath%20d='M157.87%2082.728c0%203.984%201.176%207.728%203.528%2011.232%202.352%203.504%204.536%205.256%206.552%205.256%201.728%200%202.592-1.536%202.592-4.608%200-2.256-.84-5.712-2.52-10.368a1998.05%201998.05%200%200%200-2.808-7.704%20452.798%20452.798%200%200%201-2.952-8.136c-2.928%204.464-4.392%209.24-4.392%2014.328m15.84%205.544c0%204.704-.792%208.208-2.376%2010.512-1.584%202.352-3.6%203.528-6.048%203.528-3.12%200-6-1.68-8.64-5.04-2.592-3.312-3.888-7.44-3.888-12.384.336-3.408%201.248-6.552%202.736-9.432%201.536-2.88%203.576-5.856%206.12-8.928-1.632-4.464-2.76-7.992-3.384-10.584-2.064%202.64-4.44%203.96-7.128%203.96-2.688%200-5.04-1.368-7.056-4.104-2.016-2.736-3.024-6.672-3.024-11.808%200-.528.384-.888%201.152-1.08%202.304-.48%203.624-.72%203.96-.72.576%200%20.864.288.864.864%200%204.368.984%207.8%202.952%2010.296%201.248%201.536%202.808%202.304%204.68%202.304%201.008%200%202.064-.456%203.168-1.368-.72-3.216-1.08-5.904-1.08-8.064%200-2.208.504-3.816%201.512-4.824%202.064-1.2%203.216-1.8%203.456-1.8.48%200%20.72.36.72%201.08%200%205.232.96%2010.752%202.88%2016.56l1.224%203.816c3.6-3.888%206.336-7.224%208.208-10.008l.504.864c-1.152%201.824-2.208%203.312-3.168%204.464a161.359%20161.359%200%200%201-3.096%203.6%20676.433%20676.433%200%200%201-2.016%202.376c3.504%2010.032%205.424%2015.912%205.76%2017.64.672%203.408%201.008%206.168%201.008%208.28'/%3E%3Cpath%20d='M178.334%2012.888c0%204.608%202.736%208.904%208.208%2012.888%202.544-6.528%203.816-11.712%203.816-15.552%200-1.68-.552-3.24-1.656-4.68-1.104-1.44-2.352-2.16-3.744-2.16-1.344%200-2.568.72-3.672%202.16-1.056%201.44-1.824%202.88-2.304%204.32-.432%201.392-.648%202.4-.648%203.024m-9.36%2046.944c-.336.336-.624.504-.864.504-.384%200-.576-.192-.576-.576%200-.384.096-.696.288-.936%202.16-2.4%204.704-6.024%207.632-10.872a162.099%20162.099%200%200%200%208.064-15.12c-6.144-4.272-9.216-8.64-9.216-13.104%200-2.976.696-6%202.088-9.072%201.44-3.072%203.336-5.616%205.688-7.632%202.4-2.016%204.68-3.024%206.84-3.024%202.208%200%203.696.528%204.464%201.584.816%201.008%201.224%202.496%201.224%204.464%200%203.696-2.232%2010.608-6.696%2020.736%201.584%201.056%203.696%202.352%206.336%203.888a295.464%20295.464%200%200%201%206.84%203.888%2056.857%2056.857%200%200%201%205.76%203.816c3.936%203.024%205.904%206.312%205.904%209.864%200%203.504-1.824%206.792-5.472%209.864-3.648%203.024-7.344%204.536-11.088%204.536-5.904%200-11.16-3.072-15.768-9.216-.528-.72-.792-1.32-.792-1.8%200-.528.6-1.272%201.8-2.232%201.2-1.008%202.136-1.512%202.808-1.512.144%200%20.264.072.36.216%201.296%202.256%203.624%204.656%206.984%207.2%203.36%202.544%206.648%203.816%209.864%203.816%203.984-.288%205.976-2.256%205.976-5.904%200-3.072-1.752-5.952-5.256-8.64-2.592-1.968-5.784-4.032-9.576-6.192-3.792-2.208-6.408-3.792-7.848-4.752-5.808%2012.192-11.064%2020.928-15.768%2026.208M230.382%2041.688c0-1.44-.912-2.16-2.736-2.16-1.824%200-3.336.816-4.536%202.448-1.2%201.632-1.8%203.72-1.8%206.264%200%202.496.96%204.776%202.88%206.84%201.968%202.016%204.896%203.024%208.784%203.024%202.448%200%204.824-.576%207.128-1.728%202.352-1.2%204.344-2.976%205.976-5.328l.504.864c-1.728%203.12-4.392%205.544-7.992%207.272-3.552%201.728-7.152%202.592-10.8%202.592-3.6%200-6.552-.768-8.856-2.304-2.256-1.488-3.384-3.648-3.384-6.48%200-3.6%201.416-7.008%204.248-10.224%202.88-3.216%206.456-4.824%2010.728-4.824%201.488%200%202.592.384%203.312%201.152.72.72%201.08%201.704%201.08%202.952%200%201.2-.432%202.4-1.296%203.6-.864%201.152-1.848%201.728-2.952%201.728-.576%200-1.176-.216-1.8-.648-.576-.48-.864-.864-.864-1.152%200-.336.12-.6.36-.792.24-.24.528-.456.864-.648.768-.384%201.152-1.2%201.152-2.448'/%3E%3Cpath%20d='m251.359%2047.088-1.368-.072c-.48%200-.816.216-1.008.648-.576%201.44-1.488%203.072-2.736%204.896l-.576-.792c.96-1.296%201.704-2.928%202.232-4.896%200-.384-.168-.648-.504-.792-2.16-.72-3.24-2.616-3.24-5.688%200-.672.576-1.296%201.728-1.872%201.152-.624%202.112-.936%202.88-.936.768%200%201.152.336%201.152%201.008%200%203.6%201.68%205.4%205.04%205.4.816%200%201.464-.072%201.944-.216.528-.192.816-.288.864-.288.48%200%20.72.36.72%201.08%200%20.672-.192%201.152-.576%201.44-.336.24-.72.792-1.152%201.656-.432.816-.648%201.776-.648%202.88%200%202.16.624%203.864%201.872%205.112%201.296%201.2%202.88%201.8%204.752%201.8%201.92%200%203.816-.552%205.688-1.656%201.872-1.104%203.504-2.688%204.896-4.752l.504.864c-1.68%202.928-4.008%205.28-6.984%207.056-2.976%201.776-5.64%202.664-7.992%202.664-4.8%200-7.2-2.184-7.2-6.552%200-.816.288-1.92.864-3.312.576-1.392%201.152-2.568%201.728-3.528l.864-1.44c0-.192-.072-.288-.216-.288-1.536.384-2.712.576-3.528.576'/%3E%3Cpath%20d='M273.24%2042.84c-.24%202.016-.36%203.672-.36%204.968%200%204.56.864%208.112%202.592%2010.656%201.776%202.496%203.912%203.744%206.408%203.744%202.544%200%205.064-.888%207.56-2.664%202.496-1.728%204.824-4.272%206.984-7.632l-.504-.864c-3.744%205.136-7.2%207.704-10.368%207.704-2.016%200-3.648-1.08-4.896-3.24-1.248-2.16-1.872-5.088-1.872-8.784%200-1.92.168-3.864.504-5.832%200-.432-.192-.648-.576-.648-.336%200-1.944.576-4.824%201.728-.432.144-.648.432-.648.864m5.976-15.48c.768.816%201.152%201.8%201.152%202.952s-.384%202.136-1.152%202.952c-.72.816-1.608%201.224-2.664%201.224-1.008%200-1.872-.408-2.592-1.224-.72-.816-1.08-1.8-1.08-2.952s.36-2.136%201.08-2.952c.72-.816%201.584-1.224%202.592-1.224%201.056%200%201.944.408%202.664%201.224'/%3E%3Cpath%20d='M310.14%2045.36c-.576%200-.864.576-.864%201.728%200%201.152.456%202.52%201.368%204.104.96%201.536%202.16%202.76%203.6%203.672.048-.24.072-.6.072-1.08%200-2.112-.408-4.032-1.224-5.76-.816-1.776-1.8-2.664-2.952-2.664m-13.464-24.912c0%209.6%201.104%2017.76%203.312%2024.48%202.16-5.904%203.24-13.8%203.24-23.688%200-4.272-.264-7.8-.792-10.584s-1.248-4.176-2.16-4.176c-1.2%200-2.112%201.296-2.736%203.888-.576%202.544-.864%205.904-.864%2010.08m11.448-6.84c0%204.704-.816%2010.32-2.448%2016.848-1.584%206.528-3.312%2011.832-5.184%2015.912%201.488%204.224%203.192%207.488%205.112%209.792%201.92%202.256%203.672%203.384%205.256%203.384s2.64-.984%203.168-2.952c-2.16-.96-4.008-2.496-5.544-4.608-1.488-2.112-2.232-4.224-2.232-6.336%200-1.104.264-1.992.792-2.664.528-.672%201.296-1.008%202.304-1.008%202.496%200%204.416.96%205.76%202.88%201.392%201.872%202.088%204.128%202.088%206.768%200%201.488-.24%202.904-.72%204.248.48.144%201.032.216%201.656.216%202.64%200%204.992-1.68%207.056-5.04l.576.72c-2.16%203.696-4.872%205.544-8.136%205.544-.384%200-.96-.048-1.728-.144-1.68%203.12-4.224%204.68-7.632%204.68-3.936%200-7.536-2.352-10.8-7.056-1.584-2.352-2.856-5.568-3.816-9.648-1.008-4.128-1.512-8.712-1.512-13.752%200-5.04.432-9.6%201.296-13.68.816-4.08%202.064-7.44%203.744-10.08%201.68-2.64%203.6-3.96%205.76-3.96%203.456%200%205.184%203.312%205.184%209.936'/%3E%3Cpath%20d='m332.694%2037.656.072-.936c0-.576-.648-.864-1.944-.864a5.858%205.858%200%200%200-3.528%201.152c-1.008.768-1.512%201.8-1.512%203.096%200%202.304%201.656%203.456%204.968%203.456.528%200%201.056-.072%201.584-.216a5.437%205.437%200%200%201%201.728-.288c.576%200%20.864.192.864.576%200%20.048-.192.168-.576.36-.384.144-.864.384-1.44.72-.528.336-1.08.768-1.656%201.296-1.344%201.248-2.016%202.952-2.016%205.112s.648%203.816%201.944%204.968c1.296%201.104%202.976%201.656%205.04%201.656s4.176-.6%206.336-1.8a14.695%2014.695%200%200%200%205.256-4.896l.504.864c-1.824%203.168-4.368%205.664-7.632%207.488-3.216%201.872-6.168%202.808-8.856%202.808-2.64%200-4.68-.552-6.12-1.656-1.392-1.104-2.088-2.52-2.088-4.248%200-1.776.432-3.408%201.296-4.896.864-1.488%201.608-2.544%202.232-3.168.672-.672%201.152-1.128%201.44-1.368.336-.288.504-.48.504-.576%200-.144-.024-.216-.072-.216-1.536.576-3.024.864-4.464.864-2.544%200-3.816-1.032-3.816-3.096%200-2.784%201.584-5.184%204.752-7.2%203.168-2.016%205.928-3.024%208.28-3.024%202.4%200%203.6.576%203.6%201.728%200%20.72-.384%201.488-1.152%202.304-.768.816-1.464%201.224-2.088%201.224-.96%200-1.44-.408-1.44-1.224'/%3E%3C/g%3E%3Ctext%20xml:space='preserve'%20x='280.368'%20y='13.976'%20font-family='Mr%20Bedfort'%20font-size='40'%20font-weight='400'%20letter-spacing='0'%20style='line-height:125%25;-inkscape-font-specification:Mr%20Bedfort'%20transform='translate(-177.39%20-82.362)'%20word-spacing='0'/%3E%3Cpath%20fill-rule='evenodd'%20d='M99.36%2029.25c-.061-.106.474-.57%201.596-1.31%201.123-.74%202.835-1.75%205.15-2.876%202.313-1.127%205.233-2.365%208.729-3.583%203.496-1.218%207.573-2.41%2012.103-3.567%205.291-1.357%2011.259-2.645%2017.812-3.778%206.554-1.133%2013.693-2.108%2021.297-2.923%2013.686-1.47%2028.926-2.381%2045.127-2.565%207.483-.085%2015.175-.02%2023.015.229%207.834.248%2015.51.67%2022.968%201.25%2014.92%201.156%2028.998%202.957%2041.703%205.435%206.104%201.186%2011.931%202.505%2017.35%204.046%205.42%201.541%2010.433%203.303%2014.965%205.263%204.145%201.79%207.906%203.808%2011.06%206.11%201.442%201.044%202.772%202.171%203.92%203.37%201.146%201.199%202.11%202.469%202.864%203.785a13.434%2013.434%200%200%201%201.512%203.986c.295%201.494.276%202.914.074%204.176a14.011%2014.011%200%200%201-1.3%203.977%2016.406%2016.406%200%200%201-1.587%202.577c-.977%201.305-1.626%201.855-1.732%201.773-.106-.082.333-.802%201.064-2.196a22.47%2022.47%200%200%200%201.191-2.616c.393-1.05.749-2.284.853-3.7a10.664%2010.664%200%200%200-.315-3.59c-.293-1.107-.799-2.24-1.502-3.34-.713-1.123-1.625-2.201-2.717-3.229-1.092-1.027-2.363-2.005-3.75-2.943-3.044-2.044-6.684-3.82-10.755-5.44-4.459-1.771-9.383-3.354-14.721-4.736-5.338-1.383-11.09-2.564-17.15-3.648-12.586-2.244-26.524-3.873-41.336-4.949a561.489%20561.489%200%200%200-22.791-1.181%20602.786%20602.786%200%200%200-22.847-.285c-16.088.1-31.21.836-44.806%202.057-7.56.68-14.646%201.492-21.154%202.44-6.509.95-12.44%202.035-17.714%203.176-4.53.984-8.59%201.971-12.085%202.975a106.17%20106.17%200%200%200-8.788%202.925c-2.358.907-4.145%201.7-5.364%202.228-1.22.527-1.876.783-1.938.677z'/%3E%3C/svg%3E
" width="80" height="23" alt="HastyScribe">
  </a></p>
    </div>
  </div>
  
</body>