Annotation of pkgsrc/pkgtools/pkgdiff/files/pkgvi.1, revision 1.12
1.12 ! wiz 1: .\" $NetBSD: pkgvi.1,v 1.11 2023/11/15 16:15:47 schmonz Exp $
1.1 hubertf 2: .\"
3: .\" Copyright (c) 2001 Tomasz Luchowski. All rights reserved.
4: .\"
5: .\" Redistribution and use in source and binary forms, with or without
6: .\" modification, are permitted provided that the following conditions
7: .\" are met:
8: .\" 1. Redistributions of source code must retain the above copyright
9: .\" notice, this list of conditions and the following disclaimer.
10: .\" 2. Redistributions in binary form must reproduce the above copyright
11: .\" notice, this list of conditions and the following disclaimer in the
12: .\" documentation and/or other materials provided with the distribution.
13: .\" 3. All advertising materials mentioning features or use of this software
14: .\" must display the following acknowledgement:
1.5 wiz 15: .\" This product includes software developed by Tomasz Luchowski
1.1 hubertf 16: .\" for the NetBSD Project
17: .\" 4. The name of the author may not be used to endorse or promote products
18: .\" derived from this software without specific prior written permission.
19: .\"
20: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30: .\" SUCH DAMAGE.
31: .\"
1.12 ! wiz 32: .Dd November 15, 2023
1.5 wiz 33: .Dt PKGVI 1
1.1 hubertf 34: .Os
35: .Sh NAME
36: .Nm pkgvi
1.12 ! wiz 37: .Nd run editor and make backup of given file if necessary
1.1 hubertf 38: .Sh SYNOPSIS
39: .Nm
1.7 seb 40: .Op +command
1.1 hubertf 41: .Ar file
1.12 ! wiz 42: .Op Ar file ...
1.1 hubertf 43: .Sh DESCRIPTION
44: The
1.5 wiz 45: .Nm
1.12 ! wiz 46: utility runs the user's favourite editor on a copy of specified file.
1.1 hubertf 47: If no changes are made in the editor, nothing happens.
48: Else the original file is kept as
49: .Pa filename.orig ,
1.12 ! wiz 50: and the modified file is saved as
1.5 wiz 51: .Pa filename .
52: If
1.1 hubertf 53: .Nm
54: finds
55: .Pa filename.orig ,
1.5 wiz 56: it behaves as normal editor and changes are only made to
1.2 hubertf 57: .Pa filename ,
58: not affecting
59: .Pa filename.orig .
1.8 bad 60: In both cases
61: .Nm
62: ensures that the file to be edited is writable by the user.
1.7 seb 63: .Pp
64: Available option:
65: .Bl -tag -width indent
66: .It Cm +command
67: This option is passed unmodified as first argument to the editor.
68: This is useful when the editor used is
69: .Xr vi 1 .
70: .El
1.1 hubertf 71: .Sh ENVIRONMENT
72: .Nm
1.12 ! wiz 73: uses
! 74: .Ev PKGEDITOR
! 75: if defined, then it looks for
! 76: .Ev EDITOR ,
1.5 wiz 77: if neither is defined, it uses
1.1 hubertf 78: .Xr vi 1 .
79: .Sh SEE ALSO
1.5 wiz 80: .Xr pkgdiff 1
81: .Sh AUTHORS
82: The pkgvi utility was written by
1.12 ! wiz 83: .An Tomasz Luchowski Aq Mt zuntum@NetBSD.org .
CVSweb <webmaster@jp.NetBSD.org>