77 lines
3.6 KiB
HTML
77 lines
3.6 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<!-- This manual documents Guile version 3.0.10.
|
||
|
|
|
||
|
|
Copyright (C) 1996-1997, 2000-2005, 2009-2023 Free Software Foundation,
|
||
|
|
Inc.
|
||
|
|
|
||
|
|
Copyright (C) 2021 Maxime Devos
|
||
|
|
|
||
|
|
Copyright (C) 2024 Tomas Volf
|
||
|
|
|
||
|
|
|
||
|
|
Permission is granted to copy, distribute and/or modify this document
|
||
|
|
under the terms of the GNU Free Documentation License, Version 1.3 or
|
||
|
|
any later version published by the Free Software Foundation; with no
|
||
|
|
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
|
||
|
|
copy of the license is included in the section entitled "GNU Free
|
||
|
|
Documentation License." -->
|
||
|
|
<title>option-ref Reference (Guile Reference Manual)</title>
|
||
|
|
|
||
|
|
<meta name="description" content="option-ref Reference (Guile Reference Manual)">
|
||
|
|
<meta name="keywords" content="option-ref Reference (Guile Reference Manual)">
|
||
|
|
<meta name="resource-type" content="document">
|
||
|
|
<meta name="distribution" content="global">
|
||
|
|
<meta name="Generator" content=".texi2any-real">
|
||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
|
|
||
|
|
<link href="index.html" rel="start" title="Top">
|
||
|
|
<link href="Concept-Index.html" rel="index" title="Concept Index">
|
||
|
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||
|
|
<link href="getopt_002dlong.html" rel="up" title="getopt-long">
|
||
|
|
<link href="getopt_002dlong-Reference.html" rel="prev" title="getopt-long Reference">
|
||
|
|
<style type="text/css">
|
||
|
|
<!--
|
||
|
|
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
|
||
|
|
span:hover a.copiable-link {visibility: visible}
|
||
|
|
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
|
||
|
|
-->
|
||
|
|
</style>
|
||
|
|
<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css">
|
||
|
|
|
||
|
|
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body lang="en">
|
||
|
|
<div class="subsection-level-extent" id="option_002dref-Reference">
|
||
|
|
<div class="nav-panel">
|
||
|
|
<p>
|
||
|
|
Previous: <a href="getopt_002dlong-Reference.html" accesskey="p" rel="prev">Reference Documentation for <code class="code">getopt-long</code></a>, Up: <a href="getopt_002dlong.html" accesskey="u" rel="up">The (ice-9 getopt-long) Module</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
|
||
|
|
</div>
|
||
|
|
<hr>
|
||
|
|
<h4 class="subsection" id="Reference-Documentation-for-option_002dref"><span>7.4.5 Reference Documentation for <code class="code">option-ref</code><a class="copiable-link" href="#Reference-Documentation-for-option_002dref"> ¶</a></span></h4>
|
||
|
|
|
||
|
|
<dl class="first-deffn">
|
||
|
|
<dt class="deffn" id="index-option_002dref"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">option-ref</strong> <var class="def-var-arguments">options key default</var><a class="copiable-link" href="#index-option_002dref"> ¶</a></span></dt>
|
||
|
|
<dd><p>Search <var class="var">options</var> for a command line option named <var class="var">key</var> and
|
||
|
|
return its value, if found. If the option has no value, but was given,
|
||
|
|
return <code class="code">#t</code>. If the option was not given, return <var class="var">default</var>.
|
||
|
|
<var class="var">options</var> must be the result of a call to <code class="code">getopt-long</code>.
|
||
|
|
</p></dd></dl>
|
||
|
|
|
||
|
|
<p><code class="code">option-ref</code> always succeeds, either by returning the requested
|
||
|
|
option value from the command line, or the default value.
|
||
|
|
</p>
|
||
|
|
<p>The special key <code class="code">'()</code> can be used to get a list of all
|
||
|
|
non-option arguments.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|