documentation cleanup and polish

Author: Javid Habibi

CMakeLists.txt

@@ -129,21 +129,8 @@ INSTALL(TARGETS procmon DESTINATION /usr/bin)
 
 # build debian package
 set(CPACK_GENERATOR "DEB")
-
-# are we running on centos or ubuntu build agent?
-execute_process(COMMAND lsb_release -si OUTPUT_VARIABLE distro OUTPUT_STRIP_TRAILING_WHITESPACE)
-
-if(distro STREQUAL "CentOS")
-  set(CPACK_GENERATOR "RPM")
-  execute_process(COMMAND uname -m OUTPUT_VARIABLE CPACK_RPM_PACKAGE_ARCHITECTURE OUTPUT_STRIP_TRAILING_WHITESPACE)
-  set(CPACK_PACKAGE_FILE_NAME ${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}-${AZDO_BUILD_ID}.${CPACK_RPM_PACKAGE_ARCHITECTURE})
-
-elseif(distro STREQUAL "Ubuntu")
-  set(CPACK_GENERATOR "DEB")
-  set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6 (>= 2.26.1), libstdc++6 (>= 3.4.22), libncurses5 (>= 5.0)")
-  execute_process(COMMAND dpkg --print-architecture OUTPUT_VARIABLE CPACK_DEBIAN_PACKAGE_ARCHITECTURE OUTPUT_STRIP_TRAILING_WHITESPACE)
-  set(CPACK_PACKAGE_FILE_NAME ${CPACK_PACKAGE_NAME}_${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}-${AZDO_BUILD_ID}_${CPACK_DEBIAN_PACKAGE_ARCHITECTURE})
-
-endif()
+set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6 (>= 2.26.1), libstdc++6 (>= 3.4.22), libncurses5 (>= 5.0)")
+execute_process(COMMAND dpkg --print-architecture OUTPUT_VARIABLE CPACK_DEBIAN_PACKAGE_ARCHITECTURE OUTPUT_STRIP_TRAILING_WHITESPACE)
+set(CPACK_PACKAGE_FILE_NAME ${CPACK_PACKAGE_NAME}_${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}-${AZDO_BUILD_ID}_${CPACK_DEBIAN_PACKAGE_ARCHITECTURE})
 
 include(CPack)

CONTRIBUTING.md

@@ -3,10 +3,14 @@
 Before we can accept a pull request from you, you'll need to sign a [Contributor License Agreement (CLA)](https://cla.microsoft.com). It is an automated process and you only need to do it once.
 To enable us to quickly review and accept your pull requests, always create one pull request per issue and link the issue in the pull request. Never merge multiple requests in one unless they have the same root cause. Be sure to follow our Coding Guidelines and keep code changes as small as possible. Avoid pure formatting changes to code that has not been modified otherwise. Pull requests should contain tests whenever possible.
 
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+
 # Branching
-The master branch contains current development.  While CI should ensure that master always builds, it is still considered pre-release code.  Release checkpoints will be put into stable branches for maintenance.
+The main branch contains current development.  While CI should ensure that main always builds, it is still considered pre-release code.  Release checkpoints will be put into stable branches for maintenance.
 
-To contribute, fork the repository and create a branch in your fork for your work.  Please keep branch names short and descriptive.  Please direct PRs into the upstream master branch.
+To contribute, fork the repository and create a branch in your fork for your work.  Please keep branch names short and descriptive.  Please direct PRs into the upstream main branch.
 
 ## Build and run from source
 ### Environment
@@ -33,7 +37,7 @@ sudo make install
 
 ##### 2. Build Procmon
 ```bash
-git clone <URL>
+git clone https://github.com/microsoft/Procmon-for-Linux
 cd procmon-for-linux
 mkdir build
 cd build

README.md

@@ -1,24 +1,30 @@
-# Procmon 
-Procmon is a Linux reimagining of the classic Procmon tool from the Sysinternals suite of tools for Windows.  Procmon provides a convenient and efficient way for Linux developers to trace the syscall activity on the system. 
+# Process Monitor for Linux (Preview)
+Process Monitor (Procmon) is a Linux reimagining of the classic Procmon tool from the Sysinternals suite of tools for Windows.  Procmon provides a convenient and efficient way for Linux developers to trace the syscall activity on the system.  
 
 ![Procmon in use](procmon.gif "Procmon in use")
+
+# Installation & Usage
+
+## Requirements
+* Minimum OS:
+    * Ubuntu 18.04 lts
+* `cmake` >= 3.13 (build-time only)
+* `libsqlite3-dev` >= 3.22 (build-time only)
+ 
+
 ## Install Procmon
 Checkout our [install instructions](INSTALL.md) for ditribution specific steps to install Procmon.
 
-## Building from source
+## Building Procmon from source
 
-### Build-time deps
-* `cmake` >= 3.13
-* `libsqlite3-dev` >= 3.22
 
+### 1. Install build dependencies
 ```bash
 sudo apt-get -y install bison build-essential flex git libedit-dev \
   libllvm6.0 llvm-6.0-dev libclang-6.0-dev python zlib1g-dev libelf-dev
 ```
 
-### Building
-
-#### 1. Build BCC
+### 2. Build and install BCC
 ```bash
 git clone --branch tag_v0.10.0 https://github.com/iovisor/bcc.git
 mkdir bcc/build
@@ -28,27 +34,23 @@ make
 sudo make install
 ```
 
-#### 2. Build Procmon
+### 3. Build Procmon
 ```bash
 git clone https://github.com/Microsoft/Procmon-for-Linux
-cd procmon-for-linux
+cd Procmon-for-Linux
 mkdir build
 cd build
 cmake ..
 make
 ```
 
 ### Building Procmon Packages 
-The distribution packages for Procmon for Linux are constructed utilizing `debbuild` for Debian targets and `rpmbuild` for Fedora targets.
+The distribution packages for Procmon for Linux are constructed utilizing `cpack`.
 
 To build a `deb` package of Procmon on Ubuntu simply run:
 ```sh
-make && make deb
-```
-
-To build a `rpm` package of Procmon on Fedora simply run:
-```sh
-make && make rpm
+cd build
+cpack ..
 ```
 
 ## Usage
@@ -57,6 +59,9 @@ Usage: procmon [OPTIONS]
    OPTIONS
       -h/--help            Prints this help screen
       -p/--pids            Comma separated list of process ids to monitor
+      -e/--events              Comma separated list of system calls to monitor
+      -c/--collect [FILEPATH]  Option to start Procmon in a headless mode
+      -f/--file FILEPATH       Open a Procmon trace file
 ```
 
 ### Examples
@@ -68,6 +73,24 @@ The following traces processes with process id 10 and 20
 ```
 sudo procmon -p 10,20
 ```
+The following traces process 20 only syscalls read, write and openat
+```
+sudo procmon -p 20 -e read,write,openat
+```
+The following traces process 35 and opens Procmon in headless mode to output all captured events to file procmon.db
+```
+sudo procmon -p 35 -c procmon.db
+```
+The following opens a Procmon tracefile, procmon.db, within the Procmon TUI
+```
+sudo procmon -f procmon.db
+```
+
+# Feedback
+* Ask a question on StackOverflow (tag with ProcmonForLinux)
+* Request a new feature on GitHub
+* Vote for popular feature requests
+* File a bug in GitHub Issues
 
 # Contributing
 If you are interested in fixing issues and contributing directly to the code base, please see the [document How to Contribute](CONTRIBUTING.md), which covers the following:

azure-pipelines.yaml

@@ -4,13 +4,13 @@ trigger:
     branches:
       include:
         - release/*
-        - master
+        - main
       exclude:
         - dev/*
         - test/*
 
 pr:
-- master
+- main
 
 jobs:
   - job: "Build_Procmon"