-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathShell.html
795 lines (625 loc) · 39 KB
/
Shell.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
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
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>The Fandango Shell — Fuzzing with Fandango</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=a3416100" />
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="_static/documentation_options.js?v=9eb32ce0"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
<script>let toggleHintShow = 'Click to show';</script>
<script>let toggleHintHide = 'Click to hide';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="_static/togglebutton.js?v=4a39c7ea"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
<script async="async" src="_static/sphinx-thebe.js?v=c100c467"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
<script>DOCUMENTATION_OPTIONS.pagename = 'Shell';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Data Generators and Fakers" href="Generators.html" />
<link rel="prev" title="Shaping Inputs with Constraints" href="Constraints.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search this book..."
aria-label="Search this book..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<aside class="bd-header-announcement" aria-label="Announcement">
<div class="bd-header-announcement__content"><p>💃 Fandango is currently in development - see our <a href="https://github.com/fandango-fuzzer/fandango/issues" style="color:white;">list of bugs and incomplete features</a>. Expect a first stable release in April 2025.</p></div>
</aside>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="Intro.html">
<img src="_static/fandango.png" class="logo__image only-light" alt="Fuzzing with Fandango - Home"/>
<img src="_static/fandango.png" class="logo__image only-dark pst-js-only" alt="Fuzzing with Fandango - Home"/>
</a></div>
<div class="sidebar-primary-item">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button></div>
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1">
<a class="reference internal" href="Intro.html">
Fuzzing with Fandango
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">About Fandango</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="About.html">About Fandango</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Fandango Tutorial</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Tutorial.html">Fandango Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Setup.html">Installing Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="FirstSpec.html">A First Fandango Spec</a></li>
<li class="toctree-l1"><a class="reference internal" href="Invoking.html">Invoking Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="Fuzzing.html">Fuzzing with Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="Strategies.html">Some Fuzzing Strategies</a></li>
<li class="toctree-l1"><a class="reference internal" href="Constraints.html">Shaping Inputs with Constraints</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">The Fandango Shell</a></li>
<li class="toctree-l1"><a class="reference internal" href="Generators.html">Data Generators and Fakers</a></li>
<li class="toctree-l1"><a class="reference internal" href="Regexes.html">Regular Expressions</a></li>
<li class="toctree-l1"><a class="reference internal" href="Recursive.html">Complex Input Structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="Paths.html">Accessing Input Elements</a></li>
<li class="toctree-l1"><a class="reference internal" href="ISO8601.html">Case Study: ISO 8601 Date + Time</a></li>
<li class="toctree-l1"><a class="reference internal" href="Parsing.html">Parsing and Checking Inputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="Binary.html">Generating Binary Inputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bits.html">Bits and Bit Fields</a></li>
<li class="toctree-l1"><a class="reference internal" href="Gif.html">Case Study: The GIF Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="Distributions.html">Statistical Distributions</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whitebox.html">Coverage-Guided Fuzzing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Hatching.html">Hatching Specs</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Fandango Reference</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Reference.html">Fandango Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installing.html">Installing Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib.html">Fandango Standard Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="Including.html">Fandango Spec Locations</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</button></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<div class="dropdown dropdown-source-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Source repositories">
<i class="fab fa-github"></i>
</button>
<ul class="dropdown-menu">
<li><a href="https://github.com/fandango-fuzzer/fandango" target="_blank"
class="btn btn-sm btn-source-repository-button dropdown-item"
title="Source repository"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fab fa-github"></i>
</span>
<span class="btn__text-container">Repository</span>
</a>
</li>
<li><a href="https://github.com/fandango-fuzzer/fandango/issues/new?title=Issue%20on%20page%20%2FShell.html&body=Your%20issue%20content%20here." target="_blank"
class="btn btn-sm btn-source-issues-button dropdown-item"
title="Open an issue"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-lightbulb"></i>
</span>
<span class="btn__text-container">Open issue</span>
</a>
</li>
</ul>
</div>
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="_sources/Shell.md" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.md</span>
</a>
</li>
<li>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button>
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-list"></span>
</button>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>The Fandango Shell</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#invoking-the-fandango-shell">Invoking the Fandango Shell</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#invoking-commands">Invoking Commands</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-a-common-environment">Setting a Common Environment</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#retrieving-settings">Retrieving Settings</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#resetting-settings">Resetting Settings</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#quotes-and-escapes">Quotes and Escapes</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#editing-commands">Editing Commands</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#invoking-commands-from-the-shell">Invoking Commands from the Shell</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#changing-the-current-directory">Changing the Current Directory</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#getting-shell-commands-from-a-file">Getting Shell Commands from a File</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#exiting-the-fandango-shell">Exiting the Fandango Shell</a></li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section class="tex2jax_ignore mathjax_ignore" id="the-fandango-shell">
<span id="sec-shell"></span><h1>The Fandango Shell<a class="headerlink" href="#the-fandango-shell" title="Link to this heading">#</a></h1>
<p>Sometimes, you may find cumbersome to invoke Fandango from the command line again and again. This is especially true when</p>
<ul class="simple">
<li><p>You want to explore the effects of different constraints.</p></li>
<li><p>You want to explore the effects of different algorithm settings.</p></li>
</ul>
<p>This is why Fandango offers a <em>shell</em>, in which</p>
<ul class="simple">
<li><p>you can enter commands directly at a Fandango prompt</p></li>
<li><p>you can set and edit parameters <em>once</em> for future commands</p></li>
<li><p>settings are preserved during your session</p></li>
<li><p>your command history is preserved across sessions.</p></li>
</ul>
<section id="invoking-the-fandango-shell">
<h2>Invoking the Fandango Shell<a class="headerlink" href="#invoking-the-fandango-shell" title="Link to this heading">#</a></h2>
<p>Invoking the Fandango shell is easy.
Just invoke Fandango without a command:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>fandango
</pre></div>
</div>
<p>and you will be greeted by the Fandango prompt</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="invoking-commands">
<h2>Invoking Commands<a class="headerlink" href="#invoking-commands" title="Link to this heading">#</a></h2>
<p>At the <code class="docutils literal notranslate"><span class="pre">(fandango)</span></code> prompt, you can enter the same commands you already know from the command line, such as</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="n">fuzz</span> <span class="o">-</span><span class="n">f</span> <span class="n">persons</span><span class="o">.</span><span class="n">fan</span> <span class="o">-</span><span class="n">n</span> <span class="mi">10</span>
</pre></div>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Use TAB to complete commands, options, and file names.</p>
</div>
<p>and you will get the same results:</p>
<div class="cell tag_remove-input docutils container">
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>Lw Ysjmz,99635
Slmu Ws,068
Xmii Qv,608
Fcpks Eejmo,60
Vugjdp Frty,219
Rxdu Azqmqn,458
Zpehq Daso,2081
Hapko Aatos,730
Dmgxqs Vcd,7461
Zoejfq Mox,0438
</pre></div>
</div>
</div>
</div>
<p>There is an important advantage though: You can set (and edit) a <em>common environment</em> for all commands.</p>
</section>
<section id="setting-a-common-environment">
<h2>Setting a Common Environment<a class="headerlink" href="#setting-a-common-environment" title="Link to this heading">#</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">set</span></code> command (available only in the Fandango shell) allows you to specify resources and settings that are then applied to all later commands (notably, <code class="docutils literal notranslate"><span class="pre">fuzz</span></code>).</p>
<p>You can, for instance, specify a <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="nb">set</span> <span class="o">-</span><span class="n">f</span> <span class="n">persons</span><span class="o">.</span><span class="n">fan</span> <span class="o">-</span><span class="n">n</span> <span class="mi">10</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A big advantage of the <code class="docutils literal notranslate"><span class="pre">set</span></code> command is that the <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file is read only <em>once</em>,
and then available for all later commands.</p>
</div>
<p>After options for resources and settings are set, you can omit them from later <code class="docutils literal notranslate"><span class="pre">fuzz</span></code> commands:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="n">fuzz</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you give <code class="docutils literal notranslate"><span class="pre">fuzz</span></code> additional options, these temporarily <em>override</em> the settings given with <code class="docutils literal notranslate"><span class="pre">set</span></code> earlier.
As an exception, <em>constraints</em> (<code class="docutils literal notranslate"><span class="pre">-c</span></code>) are <em>added</em> to those already set.</p>
</div>
<p>The options for the <code class="docutils literal notranslate"><span class="pre">set</span></code> command are roughly the same as for the <code class="docutils literal notranslate"><span class="pre">fuzz</span></code> command and include</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">.fan</span></code> files (<code class="docutils literal notranslate"><span class="pre">set</span> <span class="pre">-f</span> <span class="pre">FILE</span></code>)</p></li>
<li><p>constraints (<code class="docutils literal notranslate"><span class="pre">set</span> <span class="pre">-c</span> <span class="pre">CONSTRAINT</span></code>)</p></li>
<li><p>algorithm settings (<code class="docutils literal notranslate"><span class="pre">set</span> <span class="pre">--mutation-rate=0.2</span></code>)</p></li>
</ul>
<p>To get a full list of options, try <code class="docutils literal notranslate"><span class="pre">help</span> <span class="pre">set</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Some command-specific options like <code class="docutils literal notranslate"><span class="pre">-o</span></code> or <code class="docutils literal notranslate"><span class="pre">-d</span></code> (controlling the output of the <code class="docutils literal notranslate"><span class="pre">fuzz</span></code> command)
are not available for setting with <code class="docutils literal notranslate"><span class="pre">set</span></code>.</p>
</div>
</section>
<section id="retrieving-settings">
<h2>Retrieving Settings<a class="headerlink" href="#retrieving-settings" title="Link to this heading">#</a></h2>
<p>To retrieve the current settings, simply enter <code class="docutils literal notranslate"><span class="pre">set</span></code>.
This will list:</p>
<ul class="simple">
<li><p>the grammar and constraints of the current <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file</p></li>
<li><p>as well as any constraints or settings you have made</p></li>
</ul>
<p>Here is an example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="nb">set</span> <span class="o">-</span><span class="n">N</span> <span class="mi">10</span>
<span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="nb">set</span>
<span class="o"><</span><span class="n">start</span><span class="o">></span> <span class="p">:</span><span class="o">:=</span> <span class="o"><</span><span class="n">person_name</span><span class="o">></span> <span class="s1">','</span> <span class="o"><</span><span class="n">age</span><span class="o">></span>
<span class="o"><</span><span class="n">person_name</span><span class="o">></span> <span class="p">:</span><span class="o">:=</span> <span class="o"><</span><span class="n">first_name</span><span class="o">></span> <span class="s1">' '</span> <span class="o"><</span><span class="n">last_name</span><span class="o">></span>
<span class="o"><</span><span class="n">first_name</span><span class="o">></span> <span class="p">:</span><span class="o">:=</span> <span class="o"><</span><span class="n">name</span><span class="o">></span>
<span class="o"><</span><span class="n">last_name</span><span class="o">></span> <span class="p">:</span><span class="o">:=</span> <span class="o"><</span><span class="n">name</span><span class="o">></span>
<span class="o"><</span><span class="n">name</span><span class="o">></span> <span class="p">:</span><span class="o">:=</span> <span class="o"><</span><span class="n">ascii_uppercase_letter</span><span class="o">></span> <span class="o"><</span><span class="n">ascii_lowercase_letter</span><span class="o">>+</span>
<span class="o"><</span><span class="n">age</span><span class="o">></span> <span class="p">:</span><span class="o">:=</span> <span class="o"><</span><span class="n">digit</span><span class="o">>+</span>
<span class="o">--</span><span class="nb">max</span><span class="o">-</span><span class="n">generations</span><span class="o">=</span><span class="mi">10</span>
</pre></div>
</div>
</section>
<section id="resetting-settings">
<h2>Resetting Settings<a class="headerlink" href="#resetting-settings" title="Link to this heading">#</a></h2>
<p>To reset all settings to default values, use the <code class="docutils literal notranslate"><span class="pre">reset</span></code> command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="n">reset</span>
</pre></div>
</div>
<p>This will</p>
<ul class="simple">
<li><p>clear all constraints defined with <code class="docutils literal notranslate"><span class="pre">set</span></code></p></li>
<li><p>reset all algorithm settings to their default value.</p></li>
</ul>
<p>The current <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file stays unchanged.</p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>Loading a new <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file also clears all <code class="docutils literal notranslate"><span class="pre">set</span></code> constraints.</p>
</div>
</section>
<section id="quotes-and-escapes">
<h2>Quotes and Escapes<a class="headerlink" href="#quotes-and-escapes" title="Link to this heading">#</a></h2>
<p>The Fandango shell uses the same quoting conventions as a POSIX system shell.
For instance, to set a constraint, place it in quotes:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="nb">set</span> <span class="o">-</span><span class="n">c</span> <span class="s1">'int(<age>) < 30'</span>
</pre></div>
</div>
<p>You can also escape individual characters with backslashes:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="nb">set</span> <span class="o">-</span><span class="n">c</span> <span class="nb">int</span><span class="p">(</span><span class="o"><</span><span class="n">age</span><span class="o">></span><span class="p">)</span>\ <span class="o"><</span>\ <span class="mi">30</span>
</pre></div>
</div>
</section>
<section id="editing-commands">
<h2>Editing Commands<a class="headerlink" href="#editing-commands" title="Link to this heading">#</a></h2>
<p>The Fandango shell uses the GNU readline library.
Therefore, you can</p>
<ul class="simple">
<li><p>Use cursor keys <em>left</em> and <em>right</em> to edit commands</p></li>
<li><p>Use cursor keys <em>up</em> and <em>down</em> to scroll through history</p></li>
<li><p>Use the <em>TAB</em> key to expand command names, options, and arguments.</p></li>
</ul>
<p>The command history is saved in <code class="docutils literal notranslate"><span class="pre">~/.fandango_history</span></code>.</p>
</section>
<section id="invoking-commands-from-the-shell">
<h2>Invoking Commands from the Shell<a class="headerlink" href="#invoking-commands-from-the-shell" title="Link to this heading">#</a></h2>
<p>In the Fandango shell, you can invoke <em>system commands</em> by prefixing them with <code class="docutils literal notranslate"><span class="pre">!</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>(fandango) !ls
LICENSE.md docs requirements.txt
Makefile language src
README.md pyproject.toml tests
</pre></div>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Use TAB to complete file names.</p>
</div>
<p>You can also invoke and evaluate <em>Python commands</em> by prefixing them with <code class="docutils literal notranslate"><span class="pre">/</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="o">/</span><span class="kn">import</span><span class="w"> </span><span class="nn">random</span>
<span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="o">/</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span>
<span class="mi">11</span>
</pre></div>
</div>
<p>If the command you enter has a value, the value is automatically printed.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Invoking system and Python commands is only available when the input is a terminal.</p>
</div>
</section>
<section id="changing-the-current-directory">
<h2>Changing the Current Directory<a class="headerlink" href="#changing-the-current-directory" title="Link to this heading">#</a></h2>
<p>To change the current directory, Fandango provides a built-in <code class="docutils literal notranslate"><span class="pre">cd</span></code> command:</p>
<aside class="margin sidebar">
<p class="sidebar-title"></p>
<p>The alternative <code class="docutils literal notranslate"><span class="pre">!cd</span></code> does not work, as this changes the directory of the invoked shell.</p>
</aside>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">fandango</span><span class="p">)</span> <span class="n">cd</span> <span class="n">docs</span><span class="o">/</span>
</pre></div>
</div>
<p>Without arguments, <code class="docutils literal notranslate"><span class="pre">cd</span></code> switches to the home directory.</p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>This is different from Windows, where <code class="docutils literal notranslate"><span class="pre">cd</span></code> reports the current directory.</p>
</div>
</section>
<section id="getting-shell-commands-from-a-file">
<h2>Getting Shell Commands from a File<a class="headerlink" href="#getting-shell-commands-from-a-file" title="Link to this heading">#</a></h2>
<p>Instead of entering commands by keyboard, one can also have Fandango read in commands from a file or another command.
This is done by redirecting the <code class="docutils literal notranslate"><span class="pre">fandango</span></code> standard input.
To have Fandango read and execute commands from, say, <code class="docutils literal notranslate"><span class="pre">commands.txt</span></code>, use</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ fandango < commands.txt
</pre></div>
</div>
<p>Fandango can also process the commands issued from another program:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ echo 'fuzz -n 10 -f persons.fan' | fandango
</pre></div>
</div>
<div class="cell tag_remove-input docutils container">
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>Bog Cvemt,086
Xf Dqepf,6
Ktu Kce,31
Tinal Iw,6542
Wkwx Colnx,7204
Wqkbri Njqjw,18
Twgtav Sfyxyo,66
Nyqq Pzij,9
Ym Tx,43220
Tdorzg Uqrmw,3
</pre></div>
</div>
</div>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>The input file can contain blank lines as well as comments prefixed with <code class="docutils literal notranslate"><span class="pre">#</span></code>.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>System commands (<code class="docutils literal notranslate"><span class="pre">!</span></code>) and Python commands (<code class="docutils literal notranslate"><span class="pre">/</span></code>) are not available when reading from a file.</p>
</div>
</section>
<section id="exiting-the-fandango-shell">
<h2>Exiting the Fandango Shell<a class="headerlink" href="#exiting-the-fandango-shell" title="Link to this heading">#</a></h2>
<p>To exit the Fandango shell and return to the system command line, enter the command <code class="docutils literal notranslate"><span class="pre">exit</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>(fandango) exit
$
</pre></div>
</div>
<p>Entering an EOF (end-of-file) character, typically <code class="docutils literal notranslate"><span class="pre">Ctrl-D</span></code>, will also exit the shell.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>(fandango) ^D
$
</pre></div>
</div>
<p>In the next section, we’ll talk about <a class="reference internal" href="Generators.html#sec-generators"><span class="std std-ref">custom generators</span></a>.</p>
</section>
</section>
<script type="text/x-thebe-config">
{
requestKernel: true,
binderOptions: {
repo: "binder-examples/jupyter-stacks-datascience",
ref: "master",
},
codeMirrorConfig: {
theme: "abcdef",
mode: "python"
},
kernelOptions: {
name: "python3",
path: "./."
},
predefinedOutput: true
}
</script>
<script>kernelName = 'python3'</script>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="Constraints.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Shaping Inputs with Constraints</p>
</div>
</a>
<a class="right-next"
href="Generators.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Data Generators and Fakers</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#invoking-the-fandango-shell">Invoking the Fandango Shell</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#invoking-commands">Invoking Commands</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-a-common-environment">Setting a Common Environment</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#retrieving-settings">Retrieving Settings</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#resetting-settings">Resetting Settings</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#quotes-and-escapes">Quotes and Escapes</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#editing-commands">Editing Commands</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#invoking-commands-from-the-shell">Invoking Commands from the Shell</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#changing-the-current-directory">Changing the Current Directory</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#getting-shell-commands-from-a-file">Getting Shell Commands from a File</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#exiting-the-fandango-shell">Exiting the Fandango Shell</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By José Antonio Zamudio Amaya, Marius Smytzek, and Andreas Zeller
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2024 CISPA Helmholtz Center for Information Security (www.cispa.de). All Rights Reserved..
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
</footer>
</body>
</html>