8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / tools / scripts / hgsetup.1onbld
blob022c1a4ce35b9e971770aa6655d03074e554aeaf
1 .\" CDDL HEADER START
2 .\"
3 .\" The contents of this file are subject to the terms of the
4 .\" Common Development and Distribution License (the "License").
5 .\" You may not use this file except in compliance with the License.
6 .\"
7 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
8 .\" or http://www.opensolaris.org/os/licensing.
9 .\" See the License for the specific language governing permissions
10 .\" and limitations under the License.
11 .\"
12 .\" When distributing Covered Code, include this CDDL HEADER in each
13 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
14 .\" If applicable, add the following below this CDDL HEADER, with the
15 .\" fields enclosed by brackets "[]" replaced with your own identifying
16 .\" information: Portions Copyright [yyyy] [name of copyright owner]
17 .\"
18 .\" CDDL HEADER END
19 .\"
20 .\" Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
21 .\" Use is subject to license terms."
22 .\"
23 .TH HGSETUP 1ONBLD "Oct 2, 2008"
24 .SH NAME
25 .I hgsetup
26 \- sets up a user's ~/.hgrc for development of ON with Mercurial
27 .SH SYNOPSIS
28 \fBhgsetup [-f] [-c \fIcdm_path\fP] [-m \fImerge_path\fP] [-n \fIname\fP] [-e \fIemail\fP] [-p \fIproxy\fP] [-s \fIstyle_path\fP]
29 .SH DESCRIPTION
30 The hgsetup script sets up a user's ~/.hgrc (hgrc(5)) file for development
31 of ON (OS/Net) with Mercurial.
32 .LP
33 It populates the author and email fields with the user's information.
34 It loads the Cadmium extension.
35 It aliases canonical repositories for onnv-gate.
36 It configures Mercurial to use appropriate merge tools.
37 .SH OPTIONS
38 .TP 10
39 .B -f
40 Force the user's ~/.hgrc to be overwritten if one already exists
41 .TP 10
42 .B -c
43 Override the path to the Cadmium extension for Mercurial to load
44 .TP 10
45 .B -m
46 Override the default merge configuration, such that a single
47 specified tool is used.
48 .TP 10
49 .B -n
50 Specify the name to use for commits (default is taken from passwd file)
51 .TP 10
52 .B -e
53 Specify the email address to use for commits.
54 For SWAN users the default is taken from an LDAP query, otherwise -e
55 is mandatory.
56 .TP 10
57 .B -p
58 Specify an http_proxy to use for interacting with HTTP repositories
59 .TP 10
60 .B -s
61 Override the path to the Mercurial style file
62 .SH OUTPUT
63 .LP
64 Generates a .hgrc file in the user's home directory.
65 .SH SEE ALSO
66 .LP
67 .IR hgrc(5),
68 .IR hg(1),