head	1.4;
access;
symbols
	pkgsrc-2025Q1:1.3.0.44
	pkgsrc-2025Q1-base:1.3
	pkgsrc-2024Q4:1.3.0.42
	pkgsrc-2024Q4-base:1.3
	pkgsrc-2024Q3:1.3.0.40
	pkgsrc-2024Q3-base:1.3
	pkgsrc-2024Q2:1.3.0.38
	pkgsrc-2024Q2-base:1.3
	pkgsrc-2024Q1:1.3.0.36
	pkgsrc-2024Q1-base:1.3
	pkgsrc-2023Q4:1.3.0.34
	pkgsrc-2023Q4-base:1.3
	pkgsrc-2023Q3:1.3.0.32
	pkgsrc-2023Q3-base:1.3
	pkgsrc-2023Q2:1.3.0.30
	pkgsrc-2023Q2-base:1.3
	pkgsrc-2023Q1:1.3.0.28
	pkgsrc-2023Q1-base:1.3
	pkgsrc-2022Q4:1.3.0.26
	pkgsrc-2022Q4-base:1.3
	pkgsrc-2022Q3:1.3.0.24
	pkgsrc-2022Q3-base:1.3
	pkgsrc-2022Q2:1.3.0.22
	pkgsrc-2022Q2-base:1.3
	pkgsrc-2022Q1:1.3.0.20
	pkgsrc-2022Q1-base:1.3
	pkgsrc-2021Q4:1.3.0.18
	pkgsrc-2021Q4-base:1.3
	pkgsrc-2021Q3:1.3.0.16
	pkgsrc-2021Q3-base:1.3
	pkgsrc-2021Q2:1.3.0.14
	pkgsrc-2021Q2-base:1.3
	pkgsrc-2021Q1:1.3.0.12
	pkgsrc-2021Q1-base:1.3
	pkgsrc-2020Q4:1.3.0.10
	pkgsrc-2020Q4-base:1.3
	pkgsrc-2020Q3:1.3.0.8
	pkgsrc-2020Q3-base:1.3
	pkgsrc-2020Q2:1.3.0.6
	pkgsrc-2020Q2-base:1.3
	pkgsrc-2020Q1:1.3.0.2
	pkgsrc-2020Q1-base:1.3
	pkgsrc-2019Q4:1.3.0.4
	pkgsrc-2019Q4-base:1.3
	pkgsrc-2019Q3:1.2.0.4
	pkgsrc-2019Q3-base:1.2
	pkgsrc-2019Q2:1.2.0.2
	pkgsrc-2019Q2-base:1.2;
locks; strict;
comment	@# @;


1.4
date	2025.04.16.23.14.05;	author dholland;	state Exp;
branches;
next	1.3;
commitid	xLajq7xaMYTsBkRF;

1.3
date	2019.11.22.19.48.58;	author rillig;	state Exp;
branches;
next	1.2;
commitid	kzuOkGgaObacRSLB;

1.2
date	2019.04.28.15.22.24;	author rillig;	state Exp;
branches;
next	1.1;
commitid	EtFkodcluQQa48lB;

1.1
date	2019.04.28.13.41.18;	author rillig;	state Exp;
branches;
next	;
commitid	ifpTFhiQ0eTxv7lB;


desc
@@


1.4
log
@doc/guide: update stale freenode links to point at libera

(reported on libera by nortti)
@
text
@<!-- $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://web.libera.chat/">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>
@


1.3
log
@doc/guide: document the show-all target in the help sections
@
text
@d1 1
a1 1
<!-- $NetBSD: help-user.xml,v 1.2 2019/04/28 15:22:24 rillig Exp $ -->
d49 1
a49 1
	<ulink url="https://webchat.freenode.net/">via a web browser</ulink>
@


1.2
log
@doc/guide: add autogenerated chapter containing topics from "bmake help"
@
text
@d1 1
a1 1
<!-- $NetBSD: help-user.xml,v 1.1 2019/04/28 13:41:18 rillig Exp $ -->
d27 14
@


1.1
log
@doc/guide: add chapters for getting help
@
text
@d1 1
a1 1
<!-- $NetBSD$ -->
d13 13
d40 1
@