| 1 | package App::diroctopus ; | ||
| 2 | our $VERSION = '0.025' ; | ||
| 3 | our $DATE = '2023-04-06T11:30+09:00' ; | ||
| 4 | |||
| 5 | =encoding utf8 | ||
| 6 | |||
| 7 | =head1 NAME | ||
| 8 | |||
| 9 | App::diroctopus -- shows the longest directory branch paths (most apart each other) of a given directory. | ||
| 10 | |||
| 11 | =head1 SYNOPSIS | ||
| 12 | |||
| 13 | This module provides a Unix-like command `F<diroctopus>'. | ||
| 14 | |||
| 15 | =head1 DESCRIPTION | ||
| 16 | |||
| 17 | diroctopus [-g NUM] DIR | ||
| 18 | |||
| 19 | This command outputs the longest dirctory paths under the specified directory DIR. | ||
| 20 | The first of the output shows the deepest directory path ("DP") under DIR. | ||
| 21 | The next row on the output shows the farthest DP from any of "above", repeatedly. | ||
| 22 | NUM after `-g' specifies the number of rows by this repetition, and 12 if not specified. | ||
| 23 | (Yellow colored directory on each output of DP is the "branch point" in a sense. ) | ||
| 24 | DIR is regarded to be "." (current directory) if not specified. | ||
| 25 | |||
| 26 | Compared from the outpus of `find . -type d' (or `ls -d **/*(/)' in zsh), | ||
| 27 | the result of `diroctopus' suppresses the DP not reaching the "terminus directory" | ||
| 28 | (a ternminus directory here means a directory who has no sub-directory any more). | ||
| 29 | |||
| 30 | `perldoc App::diroctopus' shows English help. | ||
| 31 | `perldoc diroctopus' and `diroctopus --help' shows Japanese help. | ||
| 32 | |||
| 33 | Options (selected): | ||
| 34 | -. 0 : Specifies not to follow any dot file (whose name begins with period character). | ||
| 35 | -g NUM : The maximum number of directory paths to be shown as a branch. | ||
| 36 | -l NUM : The minimum number of the "distance" from branch that a shown directory has. | ||
| 37 | -s NUM : A random seed for reproductivity because "farthest DPs" are chosen arbitrarily. | ||
| 38 | |||
| 39 | =head1 NOTE | ||
| 40 | |||
| 41 | The explanation above may not be enough. Japanese help explains more. | ||
| 42 | And this progragm is under development, its functions and output should be refined more. | ||
| 43 | |||
| 44 | =head1 SEE ALSO | ||
| 45 | |||
| 46 | App::dirstrata -- gives minute hierarchial information about a directory using a triangular matrix. | ||
| 47 | |||
| 48 | =head1 AUTHOR | ||
| 49 | |||
| 50 | 下野寿之 Toshiyuki SHIMONO <bin4tsv@gmail.com> The Institute of Statistical Mathematics, a visiting researcher. | ||
| 51 | |||
| 52 | =head1 COPYRIGHT AND LICENSE | ||
| 53 | |||
| 54 | Copyright (c) 2019-2023 Toshiyuki SHIMONO. All rights reserved. | ||
| 55 | This program is free software; you can redistribute it and/or | ||
| 56 | modify it under the same terms as Perl itself. | ||
| 57 | |||
| 58 | =cut | ||
| 59 | |||
| 60 | 1 ; |