add note about license
[small-misc-bash] / rmln
1 #!/bin/bash
2 # I, Ian Kelling, follow the GNU license recommendations at
3 # https://www.gnu.org/licenses/license-recommendations.en.html. They
4 # recommend that small programs, < 300 lines, be licensed under the
5 # Apache License 2.0. This file contains or is part of one or more small
6 # programs. If a small program grows beyond 300 lines, I plan to switch
7 # its license to GPL.
8
9 # Copyright 2024 Ian Kelling
10
11 # Licensed under the Apache License, Version 2.0 (the "License");
12 # you may not use this file except in compliance with the License.
13 # You may obtain a copy of the License at
14
15 # http://www.apache.org/licenses/LICENSE-2.0
16
17 # Unless required by applicable law or agreed to in writing, software
18 # distributed under the License is distributed on an "AS IS" BASIS,
19 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 # See the License for the specific language governing permissions and
21 # limitations under the License.
22
23
24 rmln () {
25 local help="Usage: rmln [RM_OPTION]... FILE...
26 wrap rm, expanding symlink arguments
27
28 Symlink arguments are recursively expanded so the links and the targets
29 are removed. All arguments to rm work.
30
31 rm's --help:
32 "
33 local file targets
34
35 # simple but correct counting past gnu rm options
36 local -i index=1
37 local options=true
38 local helped=false # only print our help once
39 while $options; do
40 if [[ "${@:index:1}" == -* ]]; then
41 if [[ "${@:index:1}" == --help ]] && ! $helped; then
42 echo "$help"
43 helped=true
44 fi
45 if [[ "${@:index:1}" == -- ]]; then
46 options=false
47 fi
48 index+=1
49 else
50 options=false
51 fi
52 done
53
54 for file in "${@:index}"; do
55 [[ -L "$file" ]] && _rmln_recurse "$file"
56 done
57 rm "$@" "${targets[@]}"
58 }
59
60 _rmln_recurse() {
61 local x="$( readlink "$1" )"
62 targets+=( "$x" )
63 [[ -L $x ]] && _rmln_recurse "$x"
64 }
65 rmln "$@"