Browse Source

Added a README file for the systemadmin plugin (#7279)

* Added a README file for the systemadmin plugin

* Updated formatting of Functions table and split it into
"named" and "unnamed" functions for clarity

* Fixed issue with '|' characters in table by adding them in
<code> stateuents </code>

* Added \ escape characters in front of | characters
Jeffrey Chandler 5 years ago
parent
commit
bbe4d89c25
1 changed files with 61 additions and 0 deletions
  1. 61 0
      plugins/systemadmin/README.md

+ 61 - 0
plugins/systemadmin/README.md

@@ -0,0 +1,61 @@
+# Systemadmin plugin
+
+This plugin adds a series of aliases and functions which make a System Administrator's life easier.
+ 
+To use it, add `systemadmin` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... systemadmin)
+```
+
+## Aliases
+
+| Alias  | Command                                                                           | Description                                                        |
+|--------|-----------------------------------------------------------------------------------|--------------------------------------------------------------------|
+| ping   | `ping -c 5`                                                                       | Sends only 5 ICMP Messages                                         |
+| clr    | `clear;echo "Currently logged in on $(tty), as $USER in directory $PWD."`         | Clears the screen and prings the current user, TTY, and directory  |
+| path   | `echo -e ${PATH//:/\\n}`                                                          | Displays PATH with each entry on a separate line                   |
+| mkdir  | `mkdir -pv`                                                                       | Automatically create parent directories and display verbose output |
+| psmem  | <code>ps -e -orss=,args= \| sort -b -k1,1n</code>                                 | Display the processes using the most memory                        |
+| psmem10| <code>ps -e -orss=,args= \| sort -b -k1,1n\| head -10</code>                      | Display the top 10 processes using the most memory                 |
+| pscpu  | <code>ps -e -o pcpu,cpu,nice,state,cputime,args\|sort -k1 -nr</code>              | Display the top processes using the most CPU                       |
+| pscpu10| <code>ps -e -o pcpu,cpu,nice,state,cputime,args\|sort -k1 -nr \| head -10</code>  | Display the top 10 processes using the most CPU                    |
+| hist10 | <code>print -l ${(o)history%% *} \| uniq -c \| sort -nr \| head -n 10</code>      | Display the top 10 most used commands in the history               |
+
+
+## Named Functions
+These are used by some of the other functions to provide flexibility
+
+| Function    |  Description                                                                                                                          |
+|-------------|---------------------------------------------------------------------------------------------------------------------------------------|
+| retval      | Returns the first argument or a '.' if no arguments are specified                                                                     |
+| retlog      | Returns the first argument or /var/log/nginx/access.log if no arguments are specified                                                 |
+
+## Unamed Functions
+These functions are closer to aliases with complex arguments simplified (in most cases) into one line
+
+| Function    |  Description                                                                                                                          |
+|-------------|---------------------------------------------------------------------------------------------------------------------------------------|
+| dls         | List only directories in the current directory                                                                                        |
+| psgrep      | List all processes that match the pattern input after the command                                                                     |
+| killit      | xargs sudo kill | Kills any process that matches a regulr expression passed to it                                                     |
+| tree        | List contents of directories in a tree-like format (if tree is installed)                                                             |
+| sortcons    | Sort connections by state                                                                                                             |
+| con80       | View all 80 Port Connections                                                                                                          |
+| sortconip   | On the connected IP sorted by the number of connections                                                                               |
+| req20       | List the top 20 requests on port 80                                                                                                   |
+| http20      | List the top 20 connections to port 80 based on tcpdump data                                                                          |
+| timewait20  | List the top 20 time_wait connections                                                                                                 |
+| syn20       | List the top 20 SYN connections                                                                                                       |
+| port_pro    | Output all processes according to the port number                                                                                     |
+| accessip10  | List the top 10 accesses to the ip address in the nginx/access.log file or another log file if specified as an argument               |
+| visitpage20 | List the top 20 most visited files or pages in the nginx/access.log file or another log file if specified as an argument              |
+| consume100  | List the top 100 of Page lists the most time-consuming (more than 60 seconds) as well as the corresponding page number of occurrences |
+| webtraffic  | List website traffic statistics in GB from tne nginx/access.log file or another log file if specified as an argument                  |
+| c404        | List statistics on 404 connections in the nginx/access.log file or another log file if specified as an argument                       |
+| httpstatus  | List statistics based on http status in the nginx/access.log file or another log file if specified as an argument                     |
+| d0          | Delete 0 byte files recursively in the directory specified (or current directory if none is specificied)                              |
+| geteip      | Gather information regarding an external IP address                                                                                   |
+| getip       | Determine the local IP Address with `ip addr` or `ifconfig`                                                                           |
+| clrz        | Clear zombie processes                                                                                                                |
+| conssec     | Display the number of concurrent connections per second in the nginix/access.log file or another log file if specified as an argument |