103 lines
4.8 KiB
HTML
103 lines
4.8 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>Help Commands (Guile Reference Manual)</title>
|
|
|
|
<meta name="description" content="Help Commands (Guile Reference Manual)">
|
|
<meta name="keywords" content="Help Commands (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="REPL-Commands.html" rel="up" title="REPL Commands">
|
|
<link href="Module-Commands.html" rel="next" title="Module Commands">
|
|
<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="subsubsection-level-extent" id="Help-Commands">
|
|
<div class="nav-panel">
|
|
<p>
|
|
Next: <a href="Module-Commands.html" accesskey="n" rel="next">Module Commands</a>, Up: <a href="REPL-Commands.html" accesskey="u" rel="up">REPL Commands</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="subsubsection" id="Help-Commands-1"><span>4.4.4.1 Help Commands<a class="copiable-link" href="#Help-Commands-1"> ¶</a></span></h4>
|
|
|
|
<p>When Guile starts interactively, it notifies the user that help can be
|
|
had by typing ‘<samp class="samp">,help</samp>’. Indeed, <code class="code">help</code> is a command, and a
|
|
particularly useful one, as it allows the user to discover the rest of
|
|
the commands.
|
|
</p>
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-help"><span class="category-def">REPL Command: </span><span><strong class="def-name">help</strong> <var class="def-var-arguments">[<code class="code">all</code> | group | <code class="code">[-c]</code> command]</var><a class="copiable-link" href="#index-help"> ¶</a></span></dt>
|
|
<dd><p>Show help.
|
|
</p>
|
|
<p>With one argument, tries to look up the argument as a group name, giving
|
|
help on that group if successful. Otherwise tries to look up the
|
|
argument as a command, giving help on the command.
|
|
</p>
|
|
<p>If there is a command whose name is also a group name, use the ‘<samp class="samp">-c
|
|
<var class="var">command</var></samp>’ form to give help on the command instead of the group.
|
|
</p>
|
|
<p>Without any argument, a list of help commands and command groups
|
|
are displayed.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-show"><span class="category-def">REPL Command: </span><span><strong class="def-name">show</strong> <var class="def-var-arguments">[topic]</var><a class="copiable-link" href="#index-show"> ¶</a></span></dt>
|
|
<dd><p>Gives information about Guile.
|
|
</p>
|
|
<p>With one argument, tries to show a particular piece of information;
|
|
currently supported topics are ‘warranty’ (or ‘w’), ‘copying’ (or ‘c’),
|
|
and ‘version’ (or ‘v’).
|
|
</p>
|
|
<p>Without any argument, a list of topics is displayed.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-apropos"><span class="category-def">REPL Command: </span><span><strong class="def-name">apropos</strong> <var class="def-var-arguments">regexp</var><a class="copiable-link" href="#index-apropos"> ¶</a></span></dt>
|
|
<dd><p>Find bindings/modules/packages.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-describe"><span class="category-def">REPL Command: </span><span><strong class="def-name">describe</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-describe"> ¶</a></span></dt>
|
|
<dd><p>Show description/documentation.
|
|
</p></dd></dl>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|