]> git.saurik.com Git - apple/shell_cmds.git/blame - path_helper/path_helper.8
shell_cmds-207.11.1.tar.gz
[apple/shell_cmds.git] / path_helper / path_helper.8
CommitLineData
ddb4a88b
A
1.\"
2.\" Copyright (c) 2007 Apple Inc. All rights reserved.
3.\"
4.\" @APPLE_LICENSE_HEADER_START@
5.\"
6.\" This file contains Original Code and/or Modifications of Original Code
7.\" as defined in and that are subject to the Apple Public Source License
8.\" Version 2.0 (the 'License'). You may not use this file except in
9.\" compliance with the License. Please obtain a copy of the License at
10.\" http://www.opensource.apple.com/apsl/ and read it before using this
11.\" file.
12.\"
13.\" The Original Code and all software distributed under the License are
14.\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17.\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18.\" Please see the License for the specific language governing rights and
19.\" limitations under the License.
20.\"
21.\" @APPLE_LICENSE_HEADER_END@
22.\"
23.Dd March 15, 2007
24.Dt path_helper 8
25.Os "Mac OS X"
26.Sh NAME
27.Nm path_helper
28.Nd helper for constructing PATH environment variable
29.Sh SYNOPSIS
30.Nm
31.Op Fl c | Fl s
32.Sh DESCRIPTION
33The
34.Nm
35utility reads the contents of the files in the directories
36.Pa /etc/paths.d
37and
38.Pa /etc/manpaths.d
39and appends their contents to the
40.Ev PATH
41and
42.Ev MANPATH
43environment variables respectively.
44(The
45.Ev MANPATH
46environment variable will not be modified unless it is already set
47in the environment.)
48.Pp
49Files in these directories should contain one path element per line.
50.Pp
51Prior to reading these directories, default
52.Ev PATH
53and
54.Ev MANPATH
55values are obtained from the files
56.Pa /etc/paths
57and
58.Pa /etc/manpaths
59respectively.
60.Pp
61Options:
62.Bl -tag -width Ds
63.It Fl c
64Generate C-shell commands on stdout. This is the default if
65.Ev SHELL
66ends with "csh".
67.It Fl s
68Generate Bourne shell commands on stdout. This is the default if
69.Ev SHELL
70does not end with "csh".
71.El
72.Sh NOTE
73The
74.Nm
75utility should not be invoked directly.
76It is intended only for use by the shell profile.