sbase/ln.1

.Dd 2015-10-08
.Dt LN 1
.Os sbase
.Sh NAME
.Nm ln
.Nd link files
.Sh SYNOPSIS
.Nm
.Op Fl f
.Op Fl L | Fl P | Fl s
.Ar target
.Op Ar name
.Nm
.Op Fl f
.Op Fl L | Fl P | Fl s
.Ar target ...
.Ar directory
.Sh DESCRIPTION
.Nm
creates a hard link
.Ar name
to
.Ar target .
If no
.Ar name
is given, a hard link to
.Ar target
is created in the current directory.
If more than one
.Ar target
is given,
.Nm
hardlinks them in the existing
.Ar directory .
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl f
If
.Ar name
exists and is not a
.Ar target ,
remove it to allow the link.
.It Fl L | Fl P
If
.Ar target
is a symbolic link, create a hard link to the (referenced file) |
(symbolic link itself). The former is the default.
.It Fl s
Create symbolic links instead of hard links.
Disables
.Fl L
and
.Fl P ,
because their purpose does not apply to symbolic links.
.El
.Sh SEE ALSO
.Xr cp 1 ,
.Xr link 2 ,
.Xr symlink 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
Use ISO-date-format in manpages The one specified by mdoc is hard to read for non-native speakers from countries which read the date day-first (like Germany, Greece, North-Korea, Swamp,...). This is also consistent with how we generally specify dates at suckless.org. 2015-10-08 11:15:08 -04:00			`.Dd 2015-10-08`
remove sbase-VERSION from man page, fix sponge.1 date 2015-01-31 08:20:02 -05:00			`.Dt LN 1`
Add .Os sbase and sed replace to .Os sbase $(VERSION) in make install 2015-01-31 14:37:03 -05:00			`.Os sbase`
Add mandoc-manpage for ln(1) and mark it as finished in the README. 2015-01-26 08:54:22 -05:00			`.Sh NAME`
			`.Nm ln`
			`.Nd link files`
			`.Sh SYNOPSIS`
add some mandoc pages and fix some warnings - add .Os, it is mandatory. - don't redeclare .Nm when it's not needed. - fix some warnings (checked with mandoc -Tlint). - remove some leftover old stuff. 2015-01-30 15:17:58 -05:00			`.Nm`
Add mandoc-manpage for ln(1) and mark it as finished in the README. 2015-01-26 08:54:22 -05:00			`.Op Fl f`
			`.Op Fl L \| Fl P \| Fl s`
			`.Ar target`
			`.Op Ar name`
add some mandoc pages and fix some warnings - add .Os, it is mandatory. - don't redeclare .Nm when it's not needed. - fix some warnings (checked with mandoc -Tlint). - remove some leftover old stuff. 2015-01-30 15:17:58 -05:00			`.Nm`
Add mandoc-manpage for ln(1) and mark it as finished in the README. 2015-01-26 08:54:22 -05:00			`.Op Fl f`
			`.Op Fl L \| Fl P \| Fl s`
			`.Ar target ...`
			`.Ar directory`
			`.Sh DESCRIPTION`
			`.Nm`
			`creates a hard link`
			`.Ar name`
			`to`
			`.Ar target .`
			`If no`
			`.Ar name`
			`is given, a hard link to`
			`.Ar target`
			`is created in the current directory.`
			`If more than one`
			`.Ar target`
			`is given,`
			`.Nm`
			`hardlinks them in the existing`
			`.Ar directory .`
			`.Sh OPTIONS`
			`.Bl -tag -width Ds`
			`.It Fl f`
			`If`
			`.Ar name`
Audit ln(1) 1) Clarify behaviour when the f-flag is given and a target is in its own way. 2) Fix usage()-style. 3) Group local variable declarations. 4) reorder args 5) argc style, other boolean style changes 6) improve error messages 7) set argv[argc - 1] to NULL to allow argv-centric loop later 8) BUGFIX: POSIX specifies that when with the f-flag there's a situation where a file stands in its own way for linking it should be ignored. 9) Add weprintf() where possible, so we don't pussy out when there's a small issue. This is sbase ffs! 2015-03-05 15:14:43 -05:00			`exists and is not a`
			`.Ar target ,`
			`remove it to allow the link.`
Add mandoc-manpage for ln(1) and mark it as finished in the README. 2015-01-26 08:54:22 -05:00			`.It Fl L \| Fl P`
			`If`
			`.Ar target`
fix mandoc warnings - sort references in SEE ALSO section to section number, name. - cols.1: proper order of sections. - wrap lines to max 79 column length. 2015-01-31 08:43:27 -05:00			`is a symbolic link, create a hard link to the (referenced file) \|`
			`(symbolic link itself). The former is the default.`
Add mandoc-manpage for ln(1) and mark it as finished in the README. 2015-01-26 08:54:22 -05:00			`.It Fl s`
			`Create symbolic links instead of hard links.`
			`Disables`
			`.Fl L`
			`and`
			`.Fl P ,`
			`because their purpose does not apply to symbolic links.`
			`.El`
			`.Sh SEE ALSO`
			`.Xr cp 1 ,`
			`.Xr link 2 ,`
			`.Xr symlink 2`
			`.Sh STANDARDS`
			`The`
			`.Nm`
			`utility is compliant with the`
POSIX 2013 audit Mostly manpage-shuffling according to the changes in the corrigendum, wording changes and more idiomatic expressions. All this is finished up by marking the POSIX 2013 conformant tools with .St -p1003.1-2013 which is not available in older mandoc builds or nroff, but which reflects what we actually did, so who cares? This is a huge step and it's not far until we can release sbase 0.1. 2015-03-27 12:22:48 -04:00			`.St -p1003.1-2013`
Add mandoc-manpage for ln(1) and mark it as finished in the README. 2015-01-26 08:54:22 -05:00			`specification.`