Commit Graph

93 Commits

Author SHA1 Message Date
Mateusz Piotrowski
96fdbc90b2 ports.7: Add an example of how to use flavors
At the moment the manual page is not documenting how to build
a flavored package. Let's start documenting flavors with
an example of a typical use case.

Reported by:	cem, dim
Reviewed by:	bcr, cem, mat, matthew
Approved by:	cem (src)
Differential Revision:	https://reviews.freebsd.org/D19531
2019-03-12 09:27:37 +00:00
Edward Tomasz Napierala
240d69b9b4 Fix markup - use .Pa for the directory component, not .Fa.
Reported by:	0mp
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2019-02-12 13:01:55 +00:00
Edward Tomasz Napierala
22427daf7e Add explanation of branches to the ports(7) man page.
Reviewed by:	matthew@, freebsd@mhka.no
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
Differential Revision:	https://reviews.freebsd.org/D19146
2019-02-11 20:46:32 +00:00
Mateusz Piotrowski
af1f5e647a ports.7: Do not mention deprecated WITH_SSP_PORTS and WITH_GHOSTSCRIPT_VER
As mentioned in this special status report[1] from EuroBSDCon 2013,
WITH_SSP_PORTS was relevant in the FreeBSD 9 and FreeBSD 10 days.
Nowadays, -fstack-protector is set by default. Relevant knobs and variables
are documented in ports/Mk/bsd.port.mk.

WITH_GHOSTSCRIPT_VER was part of USE_GHOSTSCRIPT, which is deprecated.

[1]: https://www.freebsd.org/news/status/report-2013-09-devsummit.html#Ports-and-Packages

Reviewed by:	bcr, mat, tobik
Approved by:	bcr (doc)
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D18056
2019-01-08 09:41:52 +00:00
Mateusz Piotrowski
154b4d392c ports.7: Add an example of getting dependencies without building them
While here, improve formatting of the EXAMPLES section in general.

Reviewed by:	bcr
Approved by:	bcr (doc)
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D18682
2018-12-30 00:27:28 +00:00
Mateusz Piotrowski
0a05369d45 ports(7): Do not mention deprecated WITH_OPENSSL_PORT.
Reviewed by:	eadler
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D18045
2018-11-20 10:01:56 +00:00
Mateusz Piotrowski
3d04377b2f Tidy up the ports.7 manual page.
- Use "Dq Li" for inline commands as we do in other manuals.
  - Pet "igor" and "mandoc -Tlint".
  - Reword some parts for clarity.
  - Add missing Xr macros.
  - Reformat SEE ALSO to make the section more readable.

Reviewed by:	eadler, krion, mat
Approved by:	krion (mentor), mat (mentor)
Differential Revision:	https://reviews.freebsd.org/D15350
2018-08-16 13:29:23 +00:00
Edward Tomasz Napierala
f1dd498487 Tweak ports(7) manual page to better explain the basics.
Reviewed by:	allanjude@ (earlier version)
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
Differential Revision:	https://reviews.freebsd.org/D16149
2018-07-11 13:53:44 +00:00
Edward Tomasz Napierala
4a7ec940e4 Fix mandoc -Tlint warning introduced in r335977.
Reported by:	0mp@
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-07-05 11:50:59 +00:00
Edward Tomasz Napierala
1b3fba16da Add trivial usage example to ports(7).
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-07-05 11:03:11 +00:00
Edward Tomasz Napierala
86b83608d8 Mention that ports are used to build packages, this fact - obvious
to the developers, but much less so to users - seems to be rather
weakly documented.

MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-06-13 18:50:51 +00:00
Edward Tomasz Napierala
8f9c737173 Get rid of references to /usr/share/doc/ from ports(7) and getosreldate(3).
The handbooks are not installed there anymore. While here, improve the
URLs markup a bit.

Reviewed by:	allanjude@
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
Differential Revision:	https://reviews.freebsd.org/D15793
2018-06-13 18:34:49 +00:00
Tijl Coosemans
bd5bd02583 Remove deprecated OVERRIDE_LINUX_BASE_PORT. It can be set via
DEFAULT_VERSIONS now (e.g. DEFAULT_VERSIONS+=linux=c7).

Noticed by:	xmj
MFC after:	2 weeks
2017-11-10 11:19:47 +00:00
Eitan Adler
a2aef24aa3 Update several more URLs
- Primarily http -> https
- Primarily FreeBSD project URLs
2017-10-29 08:17:03 +00:00
Edward Tomasz Napierala
225636dccb Fix bunch of .Xrs.
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
2016-03-28 16:48:28 +00:00
Glen Barber
9ef6fea65d Dereference portaudit(1), as it is now deprecated and its
functionality exists in pkg-audit(8).

Submitted by:	Ronald Klop <ronald-lists@klop.ws>
MFC after:	3 days
Sponsored by:	The FreeBSD Foundation
2014-06-06 13:36:52 +00:00
Benjamin Kaduk
59be36b0f7 Document some user-settable make variables in ports.7
This is not a comprehensive list, as the variables themselves are spread
out over multiple files, but it is a start.

Add a section to make.conf noting that variables may be set there that
affect ports builds, but refer to ports.7 and elsewhere for the actual
listing; any listing in make.conf.5 would likely become out of date
fairly quickly.

PR:		docs/189199
Reviewed by:	bdrewery (previous version)
Approved by:	hrs (mentor)
2014-05-18 21:05:54 +00:00
Eitan Adler
ae41fe617d Ports switched from dialog to dialog4ports some time ago.
PR:		docs/179785
Repored by:	Kevin Oberman <rkoberman@gmail.com>
Submitted by:	"Ilya A. Arkhipov" <rum1cro@yandex.ru>
MFC After:	3 days
2013-06-20 21:16:46 +00:00
Eitan Adler
7a36e6d2bb Modernize some portions of the ports man page.
Stop documenting other operating systems's default patha

Approved by:	bcr (mentor)
2013-03-04 13:57:46 +00:00
Eitan Adler
481974c226 Modernize parts of the ports.7 manual page.
Approved by:	bcr (mentor)
MFC after:	3 days
2012-11-18 16:34:09 +00:00
Glen Barber
d63559341c Fix date from r231111.
Pointy-hat to:	gjb (myself, approver of r231111)
2012-02-10 03:34:32 +00:00
Eitan Adler
eed1dcab79 ports(7) currently makes no mention of LOCALBASE: fix that
PR:		docs/159551
Submitted by:	Matthew Seaman <m.seaman@infracaninophile.co.uk>
Approved by:	gjb
MFC after:	3 days
2012-02-07 04:00:57 +00:00
Benedict Reuschling
b7642c92bf Add a short description about NO_CHECKSUM.
PR:		docs/155980
Submitted by	KOIE Hidetaka (koie at suri co jp)
MFC after:	7 days
2011-05-30 10:23:59 +00:00
Benedict Reuschling
67900914ff Add a description to the checksum target about not only
being able to verify, but also having the ability to
fetch distfiles that are missing or failed the checksum
calculation

PR:		docs/138887
Submitted by:	Radim Kolar (hsn at sendmail dot cz)
MFC after:	5 days
2011-05-25 08:42:01 +00:00
Giorgos Keramidas
1583221b9d Document TRYBROKEN in ports(7).
PR:		docs/153542
Submitted by:	Eitan Adler <lists@eitanadler.com>
MFC after:	3 days
2011-02-15 07:16:27 +00:00
Thomas Abthorpe
d40caf29b4 - Document targets run-depends-list and build-depends-list
PR:		docs/127575
Submitted by:	Walter Venable <walt relnor.com>
Approved by:	keramida
MFC after:	3 days
2009-01-21 21:29:00 +00:00
Jens Schweikhardt
f283c8f8fc Correct a typo. 2008-12-05 22:04:52 +00:00
Tom Rhodes
039b8701cf The config-recursive target is not run during the normal install process, move
it down to where it belongs.

Document 'all-depends-list' target and bump doc date.

PR:		119519
Submitted by:	Yuri Pankov <yuri.pankov@gmail.com>
Reviewed by:	flz
2008-01-22 12:23:30 +00:00
Christian Brueffer
724c0a230e Document the 'maintainer' target.
PR:		119699
Submitted by:	Warren Block <wblock@wonkity.com>
MFC after:	3 days
2008-01-21 19:52:15 +00:00
Gabor Kovesdan
d5d75e69bd - Remove incomplete sentence fragment
PR:		docs/117451
Submitted by:	Warren Block <wblock@wonkity.com>
MFC after:	3 days
2007-12-21 21:48:54 +00:00
Gabor Kovesdan
520a4bfde7 - Document PORT_DBDIR
PR:		docs/114731
Submitted by:	Matthew Seaman <m.seaman@infracaninophile.co.uk>
2007-12-21 21:44:33 +00:00
Gabor Kovesdan
1ea65ec729 - Document icase variable of make search, which can be used to control
case-sensitivity

PR:		docs/117593
Submitted by:	Nikolay Bachiyski <nbachiyski@developer.bg>
2007-12-21 21:32:12 +00:00
Gabor Kovesdan
a02c85c136 - Fix origin of the portcheckout port as we have it in the port-mgmt
category now

PR:		docs/115193
Submitted by:	Tomas Mozes <hydrapolic at gmail dot com>
Approved by:	re (bmah),
		keramida (mentor)
MFC after:	0 days
2007-08-22 18:07:41 +00:00
Xin LI
9a0e6be26a Stop mentioning /usr/X11R6.
Approved by:	re (hrs)
2007-07-24 06:41:07 +00:00
Pav Lucistnik
f48aad41dd - Update portaudit location
Submitted by:	Dominique Goncalves <dominique.goncalves@gmail.com>
MFC after:	3 days
Approved by:	re (hrs)
2007-07-16 22:52:39 +00:00
Pav Lucistnik
e34e5860ac Remove reference to a man page of pib, an obscure third-party tool, whose port
does not install any manpages.

MFC after:	3 days
2006-11-24 14:47:25 +00:00
Giorgos Keramidas
4b08dee074 Reduce our pointy-hat pool capacity by one (i.e. bump manpage date,
after the last change to this manpage).

Reminded by:	ru
2006-10-24 13:27:08 +00:00
Giorgos Keramidas
068abd5515 Document NO_IGNORE and its interation with FORBIDDEN.
Triggered by:	   a question by Panagiotis Hadgis <hadgis@ceid.upatras.gr>
2006-10-24 12:30:28 +00:00
Maxim Konovalov
be3253cad8 o Document 'make quicksearch'.
PR:		docs/103162
Submitted by:	Lars Engels
MFC after:	1 week
2006-09-18 11:49:17 +00:00
Pav Lucistnik
1f568fb20b - Document RANDOMIZE_MASTER_SITES, MASTER_SORT
- Remove OPTIONS, it's no user settable variable
2006-07-05 20:38:54 +00:00
Pav Lucistnik
c8ff7e9e42 - Document new missing target 2006-07-05 20:07:59 +00:00
Jesus R. Camou
191f93f02e Document config-recursive target.
PR:		docs/82586
Submitted by:	Imobach González Sosa <imobachgs@banot.net>
Approved by:	trhodes (mentor)
MFC after:	1 week
2005-07-20 22:22:53 +00:00
Christian Brueffer
f0ea72a038 - Remove MLINKS to nonexistant manpages
- Change some section numbers to match reality
- For MLINKS to manpages from ports, mention which port installs them

MFC after:	3 days
2005-07-14 20:29:08 +00:00
Kirill Ponomarev
a571610dc0 Introduce three new targets for ports collection:
showconfig-recursive, rmconfig-recursive and config-conditional.

MFC after:	3 days
2005-02-07 23:04:33 +00:00
Ruslan Ermilov
9cbda59000 Sort sections. 2005-01-21 08:36:40 +00:00
Kirill Ponomarev
e57fe04667 Introduce new variables FETCHINDEX, MASTER_SITE_INDEX and add
description for MASTER_SITE_BACKUP.

Based on PR:	ports/74709
Submitted by:	Valentin Nechayev <netch@netch.kiev.ua>
Reviewed by:	ru
MFC after:	3 days
2004-12-17 13:39:55 +00:00
Simon L. B. Nielsen
cd77596356 - Fix typo in portaudit reference.
- Bump document date for last commit.

Pointed out by:	ceri, ru
Pointy hat to:	simon
2004-11-19 11:44:26 +00:00
Simon L. B. Nielsen
949f900d46 - Document the DISABLE_VULNERABILITIES knob.
- Don't say this manual page is too long, it's not that long.
- s/man page/manual page/g

MFC after:	3 days
2004-11-18 19:40:00 +00:00
Kirill Ponomarev
65d476e0e0 Add descriptions for new path, info, maint, cat, bdeps, and
rdeps variables and some new examples for "make search".

Approved by:	josef (mentor)
MFC after:	2 days
2004-06-16 07:29:21 +00:00
Kirill Ponomarev
7585929e25 - Remove leading zero from document date [1]
- Remove entry which tells about periodical INDEX updates in
  the CVS repository
- Add description for fetchindex target

Requested by:	ru [1]
Approved by:	josef (mentor)
2004-06-02 20:15:34 +00:00