Browse Source

Apache license and change around options.

Douglas William Thrift 9 years ago
parent
commit
d33ffed5fb
8 changed files with 325 additions and 43 deletions
  1. 0 2
      .gitattributes
  2. 2 2
      GNUmakefile
  3. 202 0
      LICENSE
  4. 38 0
      NOTICE
  5. 31 31
      dtpstree.cpp
  6. 1 1
      foreach.hpp
  7. 28 7
      man1/dtpstree.1
  8. 23 0
      man1/dtpstree.1.in

+ 0 - 2
.gitattributes

@@ -1,2 +0,0 @@
-*.cpp	ident
-# vim: shiftwidth=8 tabstop=8

+ 2 - 2
GNUmakefile

@@ -8,8 +8,8 @@ all: dtpstree
 
 man: man1/dtpstree.1
 
-man1/%.1: %
-	help2man -Nn '$(shell sed -e '$$ s|^// ||p;d' $<.cpp)' -o $@ $(shell realpath $<)
+man1/%.1: % man1/%.1.in
+	help2man -I $@.in -Nn '$(shell sed -e '$$ s|^// ||p;d' $<.cpp)' -o $@ $(shell realpath $<)
 
 clean:
 	rm -f dtpstree $(wildcard *core)

+ 202 - 0
LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

+ 38 - 0
NOTICE

@@ -0,0 +1,38 @@
+DT PS Tree
+
+Douglas Thrift
+
+NOTICE
+
+This software contains foreach macros from Jay Freeman's Menes library:
+
+          Redistribution and use in source and binary
+   forms, with or without modification, are permitted
+   provided that the following conditions are met:
+   
+   1. Redistributions of source code must retain the
+      above copyright notice, this list of conditions
+      and the following disclaimer.
+   2. Redistributions in binary form must reproduce the
+      above copyright notice, this list of conditions
+      and the following disclaimer in the documentation
+      and/or other materials provided with the
+      distribution.
+   3. The name of the author may not be used to endorse
+      or promote products derived from this software
+      without specific prior written permission.
+   
+   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS''
+   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+   BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+   ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
+   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+   TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+   ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+ 31 - 31
dtpstree.cpp

@@ -2,7 +2,22 @@
 //
 // Douglas Thrift
 //
-// $Id$
+// dtpstree.cpp
+
+/*  Copyright 2010 Douglas Thrift
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
 
 #include <climits>
 #include <cstdio>
@@ -201,18 +216,15 @@ static void help(const char *program, option options[], int code = 0)
 	for (option *option(options); option->name; ++option)
 	{
 		std::string name(option->name);
-
-		if (name == "highlight")
-			continue;
-
 		std::ostringstream arguments;
 
 		switch (option->val)
 		{
-		case 'h':
-			arguments << "-h, --highlight"; break;
 		case 'H':
-			arguments << "-H PID, --highlight=PID"; break;
+			if (name != "highlight")
+				continue;
+
+			arguments << "-H[PID], --highlight[=PID]"; break;
 		case 0:
 			if (name == "pid")
 				arguments << "PID, --pid=PID";
@@ -239,9 +251,9 @@ static void help(const char *program, option options[], int code = 0)
 		case 'c':
 			description = "don't compact identical subtrees"; break;
 		case 'h':
-			description = "highlight the current process and its ancestors"; break;
+			description = "show this help message and exit"; break;
 		case 'H':
-			description = "highlight the process PID and its ancestors"; break;
+			description = "highlight the current process (or PID) and its\n                              ancestors"; break;
 		case 'G':
 			description = "use VT100 line drawing characters"; break;
 		case 'k':
@@ -261,15 +273,13 @@ static void help(const char *program, option options[], int code = 0)
 		case 'V':
 			description = "show version information and exit"; break;
 		case 0:
-			if (name == "help")
-				description = "show this help message and exit";
-			else if (name == "pid")
+			if (name == "pid")
 				description = "show only the tree roted at the process PID";
 			else if (name == "user")
 				description = "show only trees rooted at processes of USER";
 		}
 
-		std::printf("  %-25s %s\n", arguments.str().c_str(), description);
+		std::printf("  %-27s %s\n", arguments.str().c_str(), description);
 	}
 
 	std::exit(code);
@@ -311,8 +321,9 @@ static int options(int argc, char *argv[], pid_t &hpid, pid_t &pid, char *&user)
 		{ "arguments", no_argument, NULL, 'a' },
 		{ "ascii", no_argument, NULL, 'A' },
 		{ "compact", no_argument, NULL, 'c' },
-		{ "highlight", optional_argument, NULL, 0 },
-		{ "highlight-all", no_argument, NULL, 'h' },
+		{ "help", no_argument, NULL, 'h' },
+		{ "highlight", optional_argument, NULL, 'H' },
+		{ "highlight-all", no_argument, NULL, 'H' },
 		{ "highlight-pid", required_argument, NULL, 'H' },
 		{ "vt100", no_argument, NULL, 'G' },
 		{ "show-kernel", no_argument, NULL, 'k' },
@@ -323,7 +334,6 @@ static int options(int argc, char *argv[], pid_t &hpid, pid_t &pid, char *&user)
 		{ "uid-changes", no_argument, NULL, 'u' },
 		{ "unicode", no_argument, NULL, 'U' },
 		{ "version", no_argument, NULL, 'V' },
-		{ "help", no_argument, NULL, 0 },
 		{ "pid", required_argument, NULL, 0 },
 		{ "user", required_argument, NULL, 0 },
 		{ NULL, 0, NULL, 0 }
@@ -331,7 +341,7 @@ static int options(int argc, char *argv[], pid_t &hpid, pid_t &pid, char *&user)
 	int option, index, flags(0);
 	char *program(argv[0]);
 
-	while ((option = getopt_long(argc, argv, "aAchH:GklnptuUV", options, &index)) != -1)
+	while ((option = getopt_long(argc, argv, "aAchH::GklnptuUV", options, &index)) != -1)
 		switch (option)
 		{
 		case 'a':
@@ -345,12 +355,9 @@ static int options(int argc, char *argv[], pid_t &hpid, pid_t &pid, char *&user)
 		case 'c':
 			flags |= Compact; break;
 		case 'h':
-			hpid = getpid();
-			flags |= Highlight;
-
-			break;
+			help(program, options);
 		case 'H':
-			hpid = value<pid_t, 0, INT_MAX>(program, options);
+			hpid = optarg ? value<pid_t, 0, INT_MAX>(program, options) : getpid();
 			flags |= Highlight;
 
 			break;
@@ -384,12 +391,7 @@ static int options(int argc, char *argv[], pid_t &hpid, pid_t &pid, char *&user)
 			{
 				std::string option(options[index].name);
 
-				if (option == "highlight")
-				{
-					hpid = optarg ? value<pid_t, 0, INT_MAX>(program, options) : getpid();
-					flags |= Highlight;
-				}
-				else if (option == "pid")
+				if (option == "pid")
 				{
 					pid = value<pid_t, 0, INT_MAX>(program, options);
 					flags |= Pid;
@@ -403,8 +405,6 @@ static int options(int argc, char *argv[], pid_t &hpid, pid_t &pid, char *&user)
 					flags |= User;
 					flags &= ~Pid;
 				}
-				else
-					help(program, options);
 			}
 
 			break;

+ 1 - 1
foreach.hpp

@@ -2,7 +2,7 @@
 //
 // Douglas Thrift
 //
-// $Id: foreach.hpp 1263 2010-03-21 13:30:15Z douglas $
+// foreach.hpp
 
 /* Menes - C++ High-Level Utility Library
  * Copyright (C) 2004  Jay Freeman (saurik)

+ 28 - 7
man1/dtpstree.1

@@ -5,6 +5,9 @@ dtpstree \- display a tree of processes
 .SH SYNOPSIS
 .B dtpstree
 [\fIoptions\fR] [\fIPID|USER\fR]
+.SH DESCRIPTION
+.B dtpstree
+shows running processes as a tree.
 .SH OPTIONS
 .TP
 \fB\-a\fR, \fB\-\-arguments\fR
@@ -16,11 +19,12 @@ use ASCII line drawing characters
 \fB\-c\fR, \fB\-\-compact\fR
 don't compact identical subtrees
 .TP
-\fB\-h\fR, \fB\-\-highlight\fR
-highlight the current process and its ancestors
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
 .TP
-\fB\-H\fR PID, \fB\-\-highlight\fR=\fIPID\fR
-highlight the process PID and its ancestors
+\fB\-H[PID]\fR, \fB\-\-highlight\fR[=\fIPID\fR]
+highlight the current process (or PID) and its
+ancestors
 .TP
 \fB\-G\fR, \fB\-\-vt100\fR
 use VT100 line drawing characters
@@ -49,11 +53,28 @@ use Unicode line drawing characters
 \fB\-V\fR, \fB\-\-version\fR
 show version information and exit
 .TP
-\fB\-\-help\fR
-show this help message and exit
-.TP
 PID, \fB\-\-pid\fR=\fIPID\fR
 show only the tree roted at the process PID
 .TP
 USER, \fB\-\-user\fR=\fIUSER\fR
 show only trees rooted at processes of USER
+.SH AUTHOR
+Written by \fBDouglas Thrift\fR <\fIdouglas@douglasthrift.net\fR>.
+.SH COPYRIGHT
+.PP
+Copyright 2010 Douglas Thrift
+.PP
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+.PP
+    \fIhttp://www.apache.org/licenses/LICENSE\-2.0\fR
+.PP
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an \fB"AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND\fR, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+.SH "SEE ALSO"
+.PP
+\fBps\fR(1), \fBkvm\fR(3), \fBkvm_getargv\fR(3), \fBkvm_getprocs\fR(3).

+ 23 - 0
man1/dtpstree.1.in

@@ -0,0 +1,23 @@
+[DESCRIPTION]
+.B dtpstree
+shows running processes as a tree.
+[AUTHOR]
+Written by \fBDouglas Thrift\fR <\fIdouglas@douglasthrift.net\fR>.
+[SEE ALSO]
+.PP
+\fBps\fR(1), \fBkvm\fR(3), \fBkvm_getargv\fR(3), \fBkvm_getprocs\fR(3).
+[COPYRIGHT]
+.PP
+Copyright 2010 Douglas Thrift
+.PP
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+.PP
+    \fIhttp://www.apache.org/licenses/LICENSE\-2.0\fR
+.PP
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an \fB"AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND\fR, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.