summaryrefslogtreecommitdiff
path: root/doc/guide/files/help-user.xml
blob: d52af631cb25c6f0832464d6bf8417ac3c193d21 (plain)
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
<!-- $NetBSD: help-user.xml,v 1.3 2019/11/22 19:48:58 rillig Exp $ -->

<chapter id="help-user">
<title>Getting help</title>

<para>
	To get help when using pkgsrc, the definitive source is this
	document, the pkgsrc guide. If you don't find anything here,
	there are alternatives:
</para>

<itemizedlist>

<listitem><para>
	The built-in pkgsrc help, which is available after bootstrapping
	pkgsrc. Run <command>bmake help topic=&#x2026;</command> to get
	help for any topic, such as a variable name like
	<varname>BUILD_DEFS</varname>, a make target like
	<command>do-build</command>, a missing C or C++ function like
	<command>strcasecmp</command> or any other topic.</para>

	<para>The available help topics are listed in <xref
	linkend="help-topics" />.</para>
</listitem>

<listitem><para>
	To see the value of a single variable, run <command>bmake
	show-var VARNAME=<replaceable>X</replaceable></command>.
</para></listitem>

<listitem><para>
	To see the values of the most common variables, run
	<command>bmake show-all</command>. These variables are grouped by
	topic. To see the variables for a single topic, run
	<command>bmake
	show-all-<replaceable>topic</replaceable></command>, for example
	<command>bmake show-all-fetch</command>.
</para></listitem>

<listitem><para>
	The pkgsrc-users mailing list, to which
	<ulink url="https://www.NetBSD.org/mailinglists/#pkgsrc-users">you
	can subscribe</ulink> and then <ulink
	url="mailto:pkgsrc-users@NetBSD.org">ask your
	questions</ulink>.</para>
</listitem>

<listitem><para>The #pkgsrc IRC channel, which is accessible
	<ulink url="https://webchat.freenode.net/">via a web browser</ulink>
	or by using a specialized chat program such as
	<ulink url="http://xchat.org/">XChat</ulink>.
	Pick any user name and join the channel #pkgsrc.</para>
</listitem>

</itemizedlist>

</chapter>