From ce3543ac76d7cb3e2eaa4ad63da711fd971bbfe6 Mon Sep 17 00:00:00 2001 From: Kristofer Berggren Date: Sun, 15 Aug 2021 13:37:45 +0800 Subject: [PATCH] fixes #10 - improve documentation for macos --- src/stackusage | 11 ++++++++--- src/stackusage.1 | 6 +++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/src/stackusage b/src/stackusage index d192766..2f4d1a4 100755 --- a/src/stackusage +++ b/src/stackusage @@ -28,9 +28,9 @@ showusage() echo " --version output version information and exit" echo "" echo "Examples:" - echo "stackusage ls" + echo "stackusage ./ex001" echo "" - echo "executes the program 'ls' and measures its stack usage." + echo "executes the program 'ex001' and measures its stack usage." echo "Result is output to stderr on the following format:" echo "" echo "stackusage log at 2018-10-28 22:33:18 ----------------------------------------" @@ -43,7 +43,7 @@ showusage() showversion() { - echo "stackusage v1.12" + echo "stackusage v1.14" echo "" echo "Copyright (C) 2015-2020 Kristofer Berggren" echo "" @@ -193,6 +193,11 @@ if [ "${OUTFILE}" == "" ]; then cat "${TMPLOG}" >&2 else echo "error: unable to preload ${LIBNAME}" + if [ "$(uname)" == "Darwin" ]; then + echo "note that stackusage on macOS cannot measure stack usage on" + echo "programs protected by System Integrity Protection, it should" + echo "however work on locally compiled programs." + fi fi fi diff --git a/src/stackusage.1 b/src/stackusage.1 index 4350ab0..554fcc7 100644 --- a/src/stackusage.1 +++ b/src/stackusage.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man. -.TH STACKUSAGE "1" "December 2020" "stackusage v1.12" "User Commands" +.TH STACKUSAGE "1" "August 2021" "stackusage v1.14" "User Commands" .SH NAME stackusage \- measure stack usage in applications .SH SYNOPSIS @@ -41,9 +41,9 @@ display this help and exit \fB\-\-version\fR output version information and exit .SH EXAMPLES -stackusage ls +stackusage ./ex001 .PP -executes the program 'ls' and measures its stack usage. +executes the program 'ex001' and measures its stack usage. Result is output to stderr on the following format: .PP stackusage log at 2018\-10\-28 22:33:18 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-