iankelling.org Git - small-misc-bash/blob - README

   1 # I, Ian Kelling, follow the GNU license recommendations at
   2 # https://www.gnu.org/licenses/license-recommendations.en.html. They
   3 # recommend that small programs, < 300 lines, be licensed under the
   4 # Apache License 2.0. This file contains or is part of one or more small
   5 # programs. If a small program grows beyond 300 lines, I plan to switch
   6 # its license to GPL.
   7
   8 # Copyright 2024 Ian Kelling
   9
  10 # Licensed under the Apache License, Version 2.0 (the "License");
  11 # you may not use this file except in compliance with the License.
  12 # You may obtain a copy of the License at
  13
  14 #     http://www.apache.org/licenses/LICENSE-2.0
  15
  16 # Unless required by applicable law or agreed to in writing, software
  17 # distributed under the License is distributed on an "AS IS" BASIS,
  18 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19 # See the License for the specific language governing permissions and
  20 # limitations under the License.
  21
  22 Utility bash programs
  23
  24 dircp              Copy a directory structure
  25 directory-browser  better cd with forward, backward, and history
  26 ex                 Extract many types of files
  27 gitget             Idempotent git clone/pull
  28 hostmac            Get a host's mac address
  29 isdiff             Test if FILE1 and FILE2 have the same contents
  30 ll-function        ls -lA with enhanced output
  31 psg-function       ps grep. Grep output of ps.
  32 rmln               wrap rm, recursively expanding symlink arguments
  33 wpm-game           Typing speed game
  34
  35 The main documentation is availiable via --help and near the top of the
  36 script files next to this file. Each file is completely self contained,
  37 and generally unrelated except they are small so it's convenient to put
  38 them in the same repo.
  39
  40 Files with -function are meant to be sourced and used as a function. The
  41 other script file can be stripped of the last line and used as a
  42 function instead of a script.
  43
  44 Please email me if you have a patches (patch file or git repo are fine),
  45 bugs, feedback, or republish this somewhere else: Ian Kelling
  46 <ian@iankelling.org>.
  47
  48 There are no known bugs. Any bugs will be added to the individual
  49 documentation of each file.