neulab/tldr huggingface dataset:
This manual page was written by Giuseppe Iuculano <giuseppe@iuculano.it>, for the Debian project (but may be used by others).
sreport(1)                       Slurm Commands                       sreport(1)
sreport - Generate reports from the slurm accounting data.
sreport [OPTIONS...] [COMMAND...]
sreport is used to generate reports of job usage and cluster utilization for Slurm jobs saved to the Slurm Database, slurmdbd.
-a, --all_clusters Use all clusters instead of only the cluster from which the command was executed.
--federation Generate a report for the federation if a member of one.
-h, --help Print a help message describing the usage of sreport.
--local Generate a report for the local cluster, even if part of a federation.  Overrides --federation
-M, --cluster The cluster(s) to generate reports for. Default is local cluster, unless the local cluster is currently part of a federation and in that case generate a report for all clusters in the current federation. If the clusters included in a federation vary through time, use this option to identify the clusters to be included in report. Implies --local.
-n, --noheader Don't display header when listing results.
-Q, --quiet Print no warning or informational messages, only error messages.
-t <format> Specify the output time format. Time format options are case insensitive and may be abbreviated. The default format is Minutes. Supported time format options are listed in the time command section below.
-T,  --tres <tres_names> Trackable resource (TRES) to report values for.  By default CPU resource use is reported (except for reservation reports. All TRES types reserved by a reservation will be shown by default unless overridden with this option).  Multiple TRES names may be separated using a comma separated list for all reports except the job reports, which can only support a single TRES name, or "ALL" for all TRES.
The "Reported" Billing TRES is calculated from the largest Billing TRES of each node multiplied by the time frame. For example, if a node is part of multiple partitions and each has a different TRESBillingWeights defined the Billing TRES for the node will be the highest of the partitions.  If TRESBillingWeights is not defined on any partition for a node then the Billing TRES will be equal to the number of CPUs on the node.
TRES node usage is no longer reported in percent format or in Cluster Utilization.  Please use TRES CPU instead.  The main issue with using node is in most configurations multiple jobs are able to run on the same node.  This makes TRES node accounting count the same node multiple times in the same period.  In exclusive node configurations, CPU accounting returns the same usage node accounting would.
-v, --verbose Print detailed event logging.
<keyword> may be omitted from the execute line and sreport will execute in interactive mode. sreport will process commands as entered until explicitly terminated.
exit   Terminate the execution of sreport.  Identical to the quit command.
help   Display a description of sreport options and commands.
nonparsable Return output to normal after parsable or parsable2 has been set.
parsable Output will be | delimited with an ending '|'.
parsable2 Output will be | delimited without an ending '|'.
quit   Terminate the execution of sreport.  Identical to the exit command.
time <time_format> Specify the output time format. Time format options are case insensitive and may be abbreviated. The default format is Minutes. Supported time format options include:
SecPer    Seconds/Percentage of Total
MinPer    Minutes/Percentage of Total
HourPer   Hours/Percentage of Total
Seconds   Seconds
Minutes   Minutes
Hours     Hours
Percent   Percentage of Total
verbose Enable detailed event logging.
version Display the sreport version number.
Valid report types are: cluster <REPORT> <OPTIONS>
job <REPORT> <OPTIONS>
reservation <REPORT> <OPTIONS>
user <REPORT> <OPTIONS>
<REPORT> options for each type include:
cluster - AccountUtilizationByUser, UserUtilizationByAccount, UserUtilizationByWckey, Utilization, WCKeyUtilizationByUser
job - SizesByAccount, SizesByAccountAndWcKey, SizesByWckey
reservation - Utilization
user - TopUsage
NOTE: If OverSubscribe is configured to FORCE or YES in your slurm.conf and the system is not configured to use preemption (PreemptMode=OFF) accounting can easily grow to values greater than the actual utilization. It may be common on such systems to get error messages in the slurmdbd log stating: "We have more allocated time than is possible."
cluster AccountUtilizationByUser This report will display account utilization as it appears on the hierarchical tree.  Starting with the specified account or the root account by default this report will list the underlying usage with a sum on each level.  Use the 'tree' option to span the tree for better visibility.
NOTE: Idle reservation time will be split evenly among accounts/users given access to it. When a reservation is assigned to whole accounts, the time will be counted in the association for the accounts, not the user associations in the accounts. In this case, the usage of a parent account can be larger than the sum of its children.
cluster UserUtilizationByAccount This report will display users by account in order of utilization without grouping multiple accounts by user into one, but displaying them on separate lines.
cluster UserUtilizationByWCKey This report will display users by wckey in order of utilization without grouping multiple wckey by user into one, but displaying them on separate lines.
cluster Utilization This report will display total usage divided amongst Allocated, Down, Planned Down, Idle, and Reserved time for selected clusters.
Allocated    Time that nodes were in use with active jobs or an active reservation.  This does not include reservations created with the MAINT or IGNORE_JOBS flags.
Down         Time that nodes were marked as Down or time that slurmctld was not responding (assuming TrackSlurmctldDown is set in slurmdbd.conf).
Idle         Time where nodes had no active jobs or reservations.
Overcommited Time of eligible jobs waiting in the queue over the Reserved time. Unlike Reserved, this has no limit. It is typically useful to determine whether your system is overloaded and by how much.
PlannedDown  Time that nodes were in use by a reservation created with the MAINT flag but not the IGNORE_JOBS flag.
Reserved     Time that a node spent idle with eligible jobs in the queue that were unable to start due to time or size constraints. The maximum time is limited to the amount of time possible on the system. If this value is not of importance for you then the number can be grouped with idle time.
TresCount    Configured number of TRES' on the reported nodes. See also the TresName field.
Note: Reservations created with the IGNORE_JOBS flag are not tracked in the Cluster Utilization report due to the fact that allowing any current/active jobs to continue to run in the reservation introduces the possibility for them to be accounted for incorrectly.
Note: The default view for the "Cluster Utilization" report includes the following fields: Cluster, Allocated, Down, PlannedDown, Idle, Reserved, Reported. You can include additional fields like OverCommitted and TresCount fields with the Format option. The TresName will also be included if using the -T, --tres <tres_names> option.
cluster WCKeyUtilizationByUser This report will display wckey utilization sorted by WCKey name for each user on each cluster.
job SizesByAccount This report will display the amount of time used for job ranges specified by the 'grouping=' option.  Only a single level in the tree is displayed defaulting to the root dir.  If you specify other accounts with the 'account=' option sreport will use those accounts as the root account and you will receive the aggregated totals of each listed account plus their sub accounts.
job SizesByAccountAndWckey This report is very similar to SizesByAccount with the difference being each account is pair with wckeys so the identifier is account:wckey instead of just account so there will most likely be multiple accounts listed depending on the number of wckeys used.
job SizesByWckey This report will display the amount of time for each wckey for job ranges specified by the 'grouping=' option.
reservation Utilization This report will display total usage for reservations on the systems.  Note: Time requests on this report will not truncate the time the reservation used, only the reservations that ran at any time during the period requested.
user TopUsage Displays the top users on a cluster.  Use the group option to group accounts together.  The default is to have a different line for each user account combination.
Each report type has various options...
OPTIONS FOR ALL REPORT TYPES
All_Clusters Use all monitored clusters. Default is local cluster.
Clusters=<OPT> List of clusters to include in report.  Default is local cluster.
End=<OPT> Period ending for report. Default is 23:59:59 of previous day. Valid time formats are...
Format=<OPT> Comma separated list of fields to display in report.
Start=<OPT> Period start for report.  Default is 00:00:00 of previous day. Valid time formats are...
OPTIONS SPECIFICALLY FOR CLUSTER REPORTS
Accounts=<OPT> When used with the UserUtilizationByAccount, or AccountUtilizationByUser, List of accounts to include in report. Default is all.
Tree   When used with the AccountUtilizationByUser report will span the accounts as they are in the hierarchy.
Users=<OPT> When used with any report other than Utilization, List of users to include in report.  Default is all.
Wckeys=<OPT> When used with the UserUtilizationByWckey or WCKeyUtilizationByUser, List of wckeys to include in report. Default is all.
OPTIONS SPECIFICALLY FOR JOB REPORTS
Accounts=<OPT> List of accounts to use for the report. Default is all which will show only one line corresponding to the totals of all accounts in the hierarchy.  This explanation does not apply when ran with the FlatView or AcctAsParent options.
AcctAsParent When used with the SizesbyAccount(*) will take specified accounts as parents and the next layer of accounts under those specified will be displayed. Default is root if no specific Accounts are requested.  When FlatView is used, this option is ignored.
FlatView When used with the SizesbyAccount(*) will not group accounts in a hierarchical level, but print each account where jobs ran on a separate line without any hierarchy.
GID=<OPT> List of group ids to include in report.  Default is all.
Grouping=<OPT> Comma separated list of size groupings.   (e.g. 50,100,150 would group job cpu count 1-49, 50-99, 100-149, > 150). grouping=individual will result in a single column for each job size found.
Jobs=<OPT> List of jobs/steps to include in report.  Default is all.
Nodes=<OPT> Only show jobs that ran on these nodes. Default is all.
Partitions=<OPT> List of partitions jobs ran on to include in report.  Default is all.
PrintJobCount When used with the Sizes report will print number of jobs ran instead of time used.
Users=<OPT> List of users jobs to include in report.  Default is all.
Wckeys=<OPT> List of wckeys to use for the report.  Default is all.  The SizesbyWckey report all users summed together.  If you want only certain users specify them with the Users= option.
OPTIONS SPECIFICALLY FOR RESERVATION REPORTS
Names=<OPT> List of reservations to use for the report. Default is all.
Nodes=<OPT> Only show reservations that used these nodes. Default is all.
OPTIONS SPECIFICALLY FOR USER REPORTS
Accounts=<OPT> List of accounts to use for the report. Default is all.
Group  Group all accounts together for each user.  Default is a separate entry for each user and account reference.
TopCount=<OPT> Used in the TopUsage report.  Change the number of users displayed.  Default is 10.
FORMAT OPTIONS FOR CLUSTER REPORTS AccountUtilizationByUser: UserUtilizationByAccount: Accounts, Cluster, Login, Proper, TresCount, Used
UserUtilizationByWckey: WCKeyUtilizationByUser: Cluster, Login, Proper, TresCount, Used, Wckey
Utilization: Allocated, Cluster, Down, Idle, Overcommitted, PlannedDown, Reported, Reserved, TresCount, TresName
FORMAT OPTIONS FOR JOB REPORTS SizesByAccount, SizesByAccountAndWckey: Account, Cluster
SizesByWckey: Wckey, Cluster
FORMAT OPTIONS FOR RESERVATION REPORTS Utilization: Allocated, Associations, Cluster, End, Flags, Idle, Name, Nodes, ReservationId, Start, TotalTime, TresCount, TresName, TresTime
FORMAT OPTIONS FOR USER REPORTS TopUsage: Account, Cluster, Login, Proper, Used
All commands and options are case-insensitive.
Executing sreport sends a remote procedure call to slurmdbd. If enough calls from sreport or other Slurm client commands that send remote procedure calls to the slurmdbd daemon come in at once, it can result in a degradation of performance of the slurmdbd daemon, possibly resulting in a denial of service.
Do not run sreport or other Slurm client commands that send remote procedure calls to slurmdbd from loops in shell scripts or other programs.  Ensure that programs limit calls to sreport to the minimum necessary for the information you are trying to gather.
Some sreport options may be set via environment variables. These environment variables, along with their corresponding options, are listed below.  (Note: commandline options will always override these settings)
SREPORT_CLUSTER     Same as -M, --cluster
SREPORT_FEDERATION  Same as --federation
SREPORT_LOCAL       Same as --local
SREPORT_TRES        Same as -t, --tres
sreport job sizesbyaccount
sreport cluster utilization
sreport user top
sreport job sizesbyaccount All_Clusters users=gore1 account=environ PrintJobCount Report number of jobs by user gore1 within the environ account
sreport cluster AccountUtilizationByUser cluster=zeus user=gore1 start=2/23/08 end=2/24/09 format=Accounts,Cluster,TresCount,Login,Proper,Used Report cluster account utilization with the specified fields during the specified 24 hour day of February 23, 2009, by user gore1
sreport cluster AccountUtilizationByUser cluster=zeus accounts=lc start=2/23/08 end=2/24/09 Report cluster account utilization by user in the LC account on cluster zeus
sreport user topusage start=2/16/09 end=2/23/09 -t percent account=lc Report top usage in percent of the lc account during the specified week
Copyright (C) 2009-2010 Lawrence Livermore National Security.  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). Copyright (C) 2010-2015 SchedMD LLC.
sacct(1), slurmdbd(8)
MPC(1)                                 mpc                                MPC(1)
mpc - mpc Documentation
mpc is a command-line client for the Music Player Daemon (MPD).  It connects to a MPD and controls it according to commands and arguments passed to it.  If no command is given, the current status is printed (same as "mpc status").
mpc [options] <command> [<arguments>]
-f, --format Configure the format used to display songs.
The metadata delimiters are:
┌───────────────┬─────────────────────────────┐ │Name           │ Description                 │ ├───────────────┼─────────────────────────────┤ │%name%         │ A name for this song.  This │ │               │ is not the song title. The  │ │               │ exact meaning of this tag   │ │               │ is not well-defined. It is  │ │               │ often used by badly         │ │               │ configured internet radio   │ │               │ stations with broken tags   │ │               │ to squeeze both the artist  │ │               │ name and the song title in  │ │               │ one tag.                    │ ├───────────────┼─────────────────────────────┤ │%artist%       │ Artist file tag             │ ├───────────────┼─────────────────────────────┤ │%album%        │ Album file tag              │ ├───────────────┼─────────────────────────────┤ │%albumartist%  │ Album Artist file tag       │ ├───────────────┼─────────────────────────────┤ │%comment%      │ Comment file tag (not       │ │               │ enabled by default in       │ │               │ mpd.conf's metadata_to_use) │ ├───────────────┼─────────────────────────────┤ │%composer%     │ Composer file tag           │ ├───────────────┼─────────────────────────────┤ │%date%         │ Date file tag               │ ├───────────────┼─────────────────────────────┤ │%originaldate% │ Original Date file tag      │ ├───────────────┼─────────────────────────────┤ │%disc%         │ Disc file tag               │ ├───────────────┼─────────────────────────────┤ │%genre%        │ Genre file tag              │ ├───────────────┼─────────────────────────────┤ │%performer%    │ Performer file tag          │ ├───────────────┼─────────────────────────────┤ │%title%        │ Title file tag              │ ├───────────────┼─────────────────────────────┤ │%track%        │ Track file tag              │ ├───────────────┼─────────────────────────────┤ │%time%         │ Duration of file            │ └───────────────┴─────────────────────────────┘
│%file%         │ Path of file, relative to   │ │               │ MPD's music_directory       │ │               │ variable                    │ ├───────────────┼─────────────────────────────┤ │%position%     │ Queue track number          │ ├───────────────┼─────────────────────────────┤ │%id%           │ Queue track id number       │ ├───────────────┼─────────────────────────────┤ │%prio%         │ Priority in the (random)    │ │               │ queue.                      │ ├───────────────┼─────────────────────────────┤ │%mtime%        │ Date and time of last file  │ │               │ modification                │ ├───────────────┼─────────────────────────────┤ │%mdate%        │ Date of last file           │ │               │ modification                │ └───────────────┴─────────────────────────────┘
The [] operator is used to group output such that if no metadata delimiters are found or matched between [ and ], then none of the characters between [ and ] are output.  & and | are logical operators for and and or.  # is used to escape characters.  Some useful examples for format are: "%file%" and "[[%artist% - ]%title%]|[%file%]".  This command also takes the following defined escape sequences:
┌───┬─────────────────┐ │\  │ backslash       │ ├───┼─────────────────┤ │\[ │ left bracket    │ ├───┼─────────────────┤ │\] │ right bracket   │ ├───┼─────────────────┤ │\a │ alert           │ ├───┼─────────────────┤ │\b │ backspace       │ ├───┼─────────────────┤ │\e │ escape          │ ├───┼─────────────────┤ │\t │ tab             │ ├───┼─────────────────┤ │\n │ newline         │ ├───┼─────────────────┤ │\v │ vertical tab    │ ├───┼─────────────────┤ │\f │ form-feed       │ ├───┼─────────────────┤ │\r │ carriage return │ └───┴─────────────────┘
If not given, the value of the environment variable MPC_FORMAT is used.
--wait Wait for operation to finish (e.g. database update).
--range=[START]:[END] Operate on a range (e.g. when loading a playlist).  START is the first index of the range, END is the first index after the range (i.e. excluding).  START and END may be omitted, making the range open to that end.  Indexes start with zero.
-q, --quiet, --no-status Prevents the current song status from being printed on completion of some of the commands.
--verbose Verbose output.
--host=HOST The MPD server to connect to.  This can be a hostname, IPv4/IPv6 address, an absolute path (i.e. local socket) or a name starting with @ (i.e. an abstract socket, Linux only).
To use a password, provide a value of the form "password@host".
If not given, the value of the environment variable MPD_HOST is used.
--port=PORT, -p PORT The TCP port of the MPD server to connect to.
If not given, the value of the environment variable MPD_PORT is used.
Commands can be used from the least unambiguous prefix (e.g insert or ins).
Player Commands consume <on|off> - Toggle consume mode if state (on or off) is not specified.
crossfade [<seconds>] - Gets and sets the current amount of crossfading between songs (0 disables crossfading).
current [--wait] - Show the currently playing song.  With --wait, mpc waits until the song changes (or until playback is started/stopped) before it queries the current song from the server.
queued - Show the currently queued (next) song.
mixrampdb [<db>] - Gets and sets the volume level at which songs with MixRamp tags will be overlapped. This disables the fading of the crossfade command and simply mixes the songs. -50.0 will effectively remove any gaps, 0.0 will mash tracks together. The amount of overlap is limited by the audio_buffer_size MPD configuration parameter.
mixrampdelay [<seconds>] - Gets and sets the current amount of extra delay added to the value computed from the MixRamp tags. (A negative value disables overlapping with MixRamp tags and restores the previous value of crossfade).
next - Starts playing next song on queue.
pause - Pauses playing.
play <position> - Starts playing the song-number specified. If none is specified, plays number 1.
prev - Starts playing previous song.
random <on|off> - Toggle random mode if state (on or off) is not specified.
repeat <on|off> - Toggle repeat mode if state (on or off) is not specified.
replaygain [<off|track|album>] - Sets the replay gain mode. Without arguments, it prints the replay gain mode.
single <on|once|off> - Toggle single mode if state (on, once, or off) is not specified.  once toggles to off.
seek [+-][<HH:MM:SS>] or <[+-]<0-100>%> - Seeks by hour, minute or seconds, hours or minutes can be omitted.  If seeking by percentage, seeks within the current song in the specified manner. If a + or - is used, the seek is done relative to the current song position. Absolute seeking by default.
seekthrough [+-][<HH:MM:SS>] - Seeks by hour, minute or seconds, hours or minutes can be omitted, relatively to the current position. If the duration exceeds the limit of the current song, the seek command proceeds to seek through the playlist until the duration is reached.  If a + is used, the seek is forward. If a - is used, the seek is backward. Forward seeking by default.
stop - Stops playing.
toggle - Toggles between play and pause. If stopped starts playing.  Does not support start playing at song number (use play).
Queue Commands add <file> - Adds a song from the music database to the queue. Can also read input from pipes. Use "mpc add /" to add all files to the queue.
insert <file> - The insert command works similarly to add except it adds song(s) after the currently playing one, rather than at the end.  When random mode is enabled, the new song is queued after the current song.
clear - Empties the queue.
crop - Remove all songs except for the currently playing song.
del <songpos> - Removes a queue number from the queue. Can also read input from pipes (0 deletes the current playing song).
mv, move <from> <to> - Moves song at position <from> to the position <to> in the queue.
searchplay <type> <query> [<type> <query>]... - Search the queue for a matching song and play it.
shuffle - Shuffles all songs on the queue.
Playlist Commands load <file> - Loads <file> as queue.  The option --range may be used to load only a portion of the file
lsplaylists: - Lists available playlists.
playlist [<playlist>] - Lists all songs in <playlist>. If no <playlist> is specified, lists all songs in the current queue.
rm <file> - Deletes a specific playlist.
save <file> - Saves playlist as <file>.
Database Commands listall [<file>] - Lists <file> from database.  If no file is specified, lists all songs in the database.
ls [<directory>] - Lists all files/folders in directory. If no directory is specified, lists all files in music directory.
search <type> <query> [<type> <query>]... - Searches for substrings in song tags.  Any number of tag type and query combinations can be specified.  Possible tag types are: artist, album, title, track, name, genre, date, composer, performer, comment, disc, filename, or any (to match any tag).
search <expression> - Searches with a filter expression, e.g.:
mpc search '((artist == "Kraftwerk") AND (title == "Metall auf Metall"))'
Check the MPD protocol documentation for details.  This syntax can be used with find and findadd as well.  (Requires libmpdclient 2.16 and MPD 0.21)
find <type> <query> [<type> <query>]... - Same as search, but tag values must match query exactly instead of doing a substring match.
findadd <type> <query> [<type> <query>]... - Same as find, but add the result to the current queue instead of printing them.
list <type> [<type> <query>]... [group <type>]... - Return a list of all tags of given tag type.  Optional search type/query limit results in a way similar to search.  Results can be grouped by one or more tags.  Example:
mpc list album group artist
stats - Displays statistics about MPD.
update [--wait] [<path>] - Scans for updated files in the music directory.  The optional parameter path (relative to the music directory) may limit the scope of the update.
With --wait, mpc waits until MPD has finished the update.
rescan [--wait] [<path>] - Like update, but also rescans unmodified files.
File Commands albumart <file> - Download album art for the given song and write it to stdout.
readpicture <file> - Download a picture embedded in the given song and write it to stdout.
Mount Commands mount - Lists all mounts.
mount <mount-path> <storage-uri> - Create a new mount: mounts a storage on the given path.  Example:
mpc mount server nfs://10.0.0.5/mp3 mpc mount stick udisks://by-id-ata-FOO-part2
unmount <mount-path> - Remove a mount.
listneighbors - Print a list of "neighors" (i.e. automatically detected storages which can be mounted).  This requires enabling at least one neighbor plugin in mpd.conf. Example:
$ mpc listneighbors upnp://uuid:01234567-89ab-cdef-0123-456789abcdef/urn:schemas-upnp-org:service:ContentDirectory:1 udisks://by-id-dm-name-_dev_sdb3 udisks://by-id-ata-FOO-part2
Sticker Commands The sticker command allows you to get and set song stickers.
sticker <file> set <key> <value> - Set the value of a song sticker.
sticker <file> get <key> - Print the value of a song sticker.
sticker <file> list - List all stickers of a song.
sticker <file> delete <key> - Delete a song sticker.
sticker <dir> find <key> - Search for stickers with the specified name, below the specified directory.
Output Commands volume [+-]<num> - Sets the volume to <num> (0-100).  If + or - is used, then it adjusts the volume relative to the current volume.
outputs - Lists all available outputs
disable [only] <output # or name> [...] - Disables the output(s); a list of one or more names or numbers is required. If only is the first argument, all other outputs are enabled.
enable [only] <output # or name> [...] - Enables the output(s); a list of one or more names or numbers is required. If only is the first argument, all other outputs are disabled.
toggleoutput <output # or name> [...] - Changes the status for the given output(s); a list of one or more names or numbers is required.
Client-to-client Commands channels - List the channels that other clients have subscribed to.
sendmessage <channel> <message> - Send a message to the specified channel.
waitmessage <channel> - Wait for at least one message on the specified channel.
subscribe <channel> - Subscribe to the specified channel and continuously receive messages.
Other Commands idle [events] - Waits until an event occurs.  Prints a list of event names, one per line.  See the MPD protocol documentation for further information.
If you specify a list of events, only these events are considered.
idleloop [events] - Similar to idle, but re-enters "idle" state after events have been printed.
status [format] - Without an argument print a three line status output equivalent to "mpc" with no arguments. If a format string is given then the delimiters are processed exactly as how they are for metadata. See the '-f' option in Options
┌──────────────┬─────────────────────────────┐ │Name          │ Description                 │ ├──────────────┼─────────────────────────────┤ │%totaltime%   │ The total duration of the   │ │              │ song.                       │ ├──────────────┼─────────────────────────────┤ │%currenttime% │ The time that the client is │ │              │ currently at.               │ └──────────────┴─────────────────────────────┘
│%percenttime% │ The percentage of time      │ │              │ elapsed for the current     │ │              │ song.                       │ ├──────────────┼─────────────────────────────┤ │%songpos%     │ The position of the current │ │              │ song within the playlist.   │ ├──────────────┼─────────────────────────────┤ │%length%      │ The number of songs within  │ │              │ the playlist                │ ├──────────────┼─────────────────────────────┤ │%state%       │ Either 'playing' or         │ │              │ 'paused'                    │ ├──────────────┼─────────────────────────────┤ │%volume%      │ The current volume spaced   │ │              │ out to 4 characters         │ │              │ including a percent sign    │ ├──────────────┼─────────────────────────────┤ │%random%      │ Current status of random    │ │              │ mode. 'on' or 'off'         │ ├──────────────┼─────────────────────────────┤ │%repeat%      │ Current status of repeat    │ │              │ mode. 'on' or 'off'         │ ├──────────────┼─────────────────────────────┤ │%single%      │ Current status of single    │ │              │ mode. 'on', 'once', or      │ │              │ 'off'                       │ ├──────────────┼─────────────────────────────┤ │%consume%     │ Current status of consume   │ │              │ mode. 'on' or 'off'         │ └──────────────┴─────────────────────────────┘
version - Reports the version of the protocol spoken, not the real version of the daemon.
All environment variables are overridden by any values specified via command line switches.
MPC_FORMAT Configure the format used to display songs.  See option --format.
MPD_HOST The MPD server to connect to.  See option --host.
MPD_PORT The TCP port of the MPD server to connect to.  See option --port.
Report bugs on https://github.com/MusicPlayerDaemon/mpc/issues
Since MPD uses UTF-8, mpc needs to convert characters to the charset used by the local system.  If you get character conversion errors when you're running mpc you probably need to set up your locale.  This is done by setting any of the LC_CTYPE, LANG or LC_ALL environment variables (LC_CTYPE only affects character handling).
mpd(1)
See https://raw.githubusercontent.com/MusicPlayerDaemon/mpc/master/AUTHORS
Copyright 2003-2021 The Music Player Daemon Project
GIT-CP(1)                          Git Extras                          GIT-CP(1)
git-cp - Copy a file keeping its history
git-cp <current_filename> <destination_filename>
Copy a file keeping its git history. This allows merge conflict handling.
Copy README into README.txt
$ git cp README README.txt
Written by Rémy Hubscher <mailto:hubscher.remy@gmail.com>
<‐ https://stackoverflow.com/questions/16937359/git-copy-file-preserving-history/44036771#44036771>
PHPDOX(1)                         User Commands                        PHPDOX(1)
phpDox - phpDox command line interface
phpdox [switches]
phpDox 0.11.0-dev - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors
-f, --file Configuration file to use (defaults to ./phpdox.xml[.dist])
-h, --help Prints this usage information
-v, --version Prints the version and exits
-c, --collector Run only collector process
-g, --generator Run only generator process
--backends Show a list of available backends and exit
--engines Show a list of available output engines and exit
--enrichers Show a list of available output enrichers and exit
--skel Show an annotated skeleton config xml file and exit
--strip Strip comments from skeleton config xml when showing
sponge(1)                           moreutils                          sponge(1)
sponge - soak up standard input and write to a file
sed '...' file | grep '...' | sponge [-a] file
sponge reads standard input and writes it out to the specified file. Unlike a shell redirect, sponge soaks up all its input before writing the output file. This allows constructing pipelines that read from and write to the same file.
sponge preserves the permissions of the output file if it already exists.
When possible, sponge creates or updates the output file atomically by renaming a temp file into place. (This cannot be done if TMPDIR is not in the same filesystem.)
If the output file is a special file or symlink, the data will be written to it, non-atomically.
If no file is specified, sponge outputs to stdout.
-a     Replace the file with a new file that contains the file's original content, with the standard input appended to it. This is done atomically when possible.
Colin Watson and Tollef Fog Heen
ACYCLIC(1)                   General Commands Manual                  ACYCLIC(1)
acyclic - make directed graph acyclic
acyclic [ -nv?  ] [ -o outfile ] [ file ]
acyclic is a filter that takes a directed graph as input and outputs a copy of the graph with sufficient edges reversed to make the graph acyclic. The reversed edge inherits all of the attributes of the original edge. The optional file argument specifies where the input graph is stored; by default, the program reads from stdin.
-n     No output is produced, though the return value will indicate whether the graph is acyclic or not.
-v     Print information about whether the file is acyclic, has a cycle or is undirected.
-?     option causes the program to print usage information.
acyclic returns 0 if the graph is acyclic; 1 if the graph has a cycle; 2 if the graph is undirected; and 255 if there are any errors.
If the graph is strict and there is a cycle of length 2, the attributes of the reversed edge are lost.
Some edge attributes are non-symmetric, referring to either the head or tail node. At present, there is no mechanism or convention for correctly switching or renaming these.
gc(1), dot(1), gvpr(1), gvcolor(1), ccomps(1), sccmap(1), tred(1), libgraph(3)
GOX(1)                                 GOX                                GOX(1)
gox - simple cross compilation tool for Go
$ gox -osarch="freebsd/386" github.com/foo/bar
Gox is a cross compiling build tool for Go which makes it possible to produce binaries for foreign platforms without having to install Go on the targeted system. Several operating systems and architectures are supported, while parallel building on multiple cores is possible.
Gox supports several target operating systems and architectures, as they are supported by the current version of the Go compiler.  Currently, choices for (-os) are: darwin (Mac OS 10.7 and above), windows, linux, freebsd, openbsd, netbsd, and plan9.  Choices for (-arch) are: amd64 (64-bit X86), 386 (32-bit x86), arm (32-bit ARM), and arm64 (64-bit ARM). If no options are given, gox builds all available pairs (-osarch) in parallel on all available cores.
Note: for the use of gox the environment variable $GOPATH must be set correctly to /usr/share/gocode. See $ go help gopath for information on this issue.
Please run gox -h for a complete list of options and additional information.
gox is written by Mitchell Hashimoto <mitchell.hashimoto@gmail.com>. This manpage is written by Daniel Stender <debian@danielstender.com>.
GIT-APPLY(1)                       Git Manual                       GIT-APPLY(1)
git-apply - Apply a patch to files and/or to the index
git apply [--stat] [--numstat] [--summary] [--check] [--index | --intent-to-add] [--3way] [--apply] [--no-add] [--build-fake-ancestor=<file>] [-R | --reverse] [--allow-binary-replacement | --binary] [--reject] [-z] [-p<n>] [-C<n>] [--inaccurate-eof] [--recount] [--cached] [--ignore-space-change | --ignore-whitespace] [--whitespace=(nowarn|warn|fix|error|error-all)] [--exclude=<path>] [--include=<path>] [--directory=<root>] [--verbose] [--unsafe-paths] [<patch>...]
Reads the supplied diff output (i.e. "a patch") and applies it to files. When running from a subdirectory in a repository, patched paths outside the directory are ignored. With the --index option the patch is also applied to the index, and with the --cached option the patch is only applied to the index. Without these options, the command applies the patch only to files, and does not require them to be in a Git repository.
This command applies the patch but does not create a commit. Use git- am(1) to create commits from patches generated by git-format-patch(1) and/or received by email.
<patch>... The files to read the patch from.  - can be used to read from the standard input.
--stat Instead of applying the patch, output diffstat for the input. Turns off "apply".
--numstat Similar to --stat, but shows the number of added and deleted lines in decimal notation and the pathname without abbreviation, to make it more machine friendly. For binary files, outputs two - instead of saying 0 0. Turns off "apply".
--summary Instead of applying the patch, output a condensed summary of information obtained from git diff extended headers, such as creations, renames and mode changes. Turns off "apply".
--check Instead of applying the patch, see if the patch is applicable to the current working tree and/or the index file and detects errors. Turns off "apply".
--index Apply the patch to both the index and the working tree (or merely check that it would apply cleanly to both if --check is in effect). Note that --index expects index entries and working tree copies for relevant paths to be identical (their contents and metadata such as file mode must match), and will raise an error if they are not, even if the patch would apply cleanly to both the index and the working tree in isolation.
--cached Apply the patch to just the index, without touching the working tree. If --check is in effect, merely check that it would apply cleanly to the index entry.
--intent-to-add When applying the patch only to the working tree, mark new files to be added to the index later (see --intent-to-add option in git- add(1)). This option is ignored unless running in a Git repository and --index is not specified. Note that --index could be implied by other options such as --cached or --3way.
-3, --3way Attempt 3-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally, possibly leaving the conflict markers in the files in the working tree for the user to resolve. This option implies the --index option unless the --cached option is used, and is incompatible with the --reject option. When used with the --cached option, any conflicts are left at higher stages in the cache.
--build-fake-ancestor=<file> Newer git diff output has embedded index information for each blob to help identify the original version that the patch applies to. When this flag is given, and if the original versions of the blobs are available locally, builds a temporary index containing those blobs.
When a pure mode change is encountered (which has no index information), the information is read from the current index instead.
-R, --reverse Apply the patch in reverse.
--reject For atomicity, git apply by default fails the whole patch and does not touch the working tree when some of the hunks do not apply. This option makes it apply the parts of the patch that are applicable, and leave the rejected hunks in corresponding *.rej files.
-z When --numstat has been given, do not munge pathnames, but use a NUL-terminated machine-readable format.
-p<n> Remove <n> leading path components (separated by slashes) from traditional diff paths. E.g., with -p2, a patch against a/dir/file will be applied directly to file. The default is 1.
-C<n> Ensure at least <n> lines of surrounding context match before and after each change. When fewer lines of surrounding context exist they all must match. By default no context is ever ignored.
--unidiff-zero By default, git apply expects that the patch being applied is a unified diff with at least one line of context. This provides good safety measures, but breaks down when applying a diff generated with --unified=0. To bypass these checks use --unidiff-zero.
Note, for the reasons stated above usage of context-free patches is discouraged.
--apply If you use any of the options marked "Turns off apply" above, git apply reads and outputs the requested information without actually applying the patch. Give this flag after those flags to also apply the patch.
--no-add When applying a patch, ignore additions made by the patch. This can be used to extract the common part between two files by first running diff on them and applying the result with this option, which would apply the deletion part but not the addition part.
--allow-binary-replacement, --binary Historically we did not allow binary patch applied without an explicit permission from the user, and this flag was the way to do so. Currently we always allow binary patch application, so this is a no-op.
--exclude=<path-pattern> Don’t apply changes to files matching the given path pattern. This can be useful when importing patchsets, where you want to exclude certain files or directories.
--include=<path-pattern> Apply changes to files matching the given path pattern. This can be useful when importing patchsets, where you want to include certain files or directories.
When --exclude and --include patterns are used, they are examined in the order they appear on the command line, and the first match determines if a patch to each path is used. A patch to a path that does not match any include/exclude pattern is used by default if there is no include pattern on the command line, and ignored if there is any include pattern.
--ignore-space-change, --ignore-whitespace When applying a patch, ignore changes in whitespace in context lines if necessary. Context lines will preserve their whitespace, and they will not undergo whitespace fixing regardless of the value of the --whitespace option. New lines will still be fixed, though.
--whitespace=<action> When applying a patch, detect a new or modified line that has whitespace errors. What are considered whitespace errors is controlled by core.whitespace configuration. By default, trailing whitespaces (including lines that solely consist of whitespaces) and a space character that is immediately followed by a tab character inside the initial indent of the line are considered whitespace errors.
By default, the command outputs warning messages but applies the patch. When git-apply is used for statistics and not applying a patch, it defaults to nowarn.
You can use different <action> values to control this behavior:
•   nowarn turns off the trailing whitespace warning.
•   warn outputs warnings for a few such errors, but applies the patch as-is (default).
•   fix outputs warnings for a few such errors, and applies the patch after fixing them (strip is a synonym --- the tool used to consider only trailing whitespace characters as errors, and the fix involved stripping them, but modern Gits do more).
•   error outputs warnings for a few such errors, and refuses to apply the patch.
•   error-all is similar to error but shows all errors.
--inaccurate-eof Under certain circumstances, some versions of diff do not correctly detect a missing new-line at the end of the file. As a result, patches created by such diff programs do not record incomplete lines correctly. This option adds support for applying such patches by working around this bug.
-v, --verbose Report progress to stderr. By default, only a message about the current patch being applied will be printed. This option will cause additional information to be reported.
--recount Do not trust the line counts in the hunk headers, but infer them by inspecting the patch (e.g. after editing the patch without adjusting the hunk headers appropriately).
--directory=<root> Prepend <root> to all filenames. If a "-p" argument was also passed, it is applied before prepending the new root.
For example, a patch that talks about updating a/git-gui.sh to b/git-gui.sh can be applied to the file in the working tree modules/git-gui/git-gui.sh by running git apply --directory=modules/git-gui.
--unsafe-paths By default, a patch that affects outside the working area (either a Git controlled working tree, or the current working directory when "git apply" is used as a replacement of GNU patch) is rejected as a mistake (or a mischief).
When git apply is used as a "better GNU patch", the user can pass the --unsafe-paths option to override this safety check. This option has no effect when --index or --cached is in use.
apply.ignoreWhitespace Set to change if you want changes in whitespace to be ignored by default. Set to one of: no, none, never, false if you want changes in whitespace to be significant.
apply.whitespace When no --whitespace flag is given from the command line, this configuration item is used as the default.
If the patch contains any changes to submodules then git apply treats these changes as follows.
If --index is specified (explicitly or implicitly), then the submodule commits must match the index exactly for the patch to apply. If any of the submodules are checked-out, then these check-outs are completely ignored, i.e., they are not required to be up to date or clean and they are not updated.
If --index is not specified, then the submodule commits in the patch are ignored and only the absence or presence of the corresponding subdirectory is checked and (if possible) updated.
git-am(1).
PRIME(1)                             OpenSSL                            PRIME(1)
openssl-prime, prime - compute prime numbers
openssl prime [-help] [-hex] [-generate] [-bits] [-safe] [-checks] [number...]
The prime command checks if the specified numbers are prime.
If no numbers are given on the command line, the -generate flag should be used to generate primes according to the requirements specified by the rest of the flags.
[-help] Display an option summary.
[-hex] Generate hex output.
[-generate] Generate a prime number.
[-bits num] Generate a prime with num bits.
[-safe] When used with -generate, generates a "safe" prime. If the number generated is n, then check that (n-1)/2 is also prime.
[-checks num] Perform the checks num times to see that the generated number is prime.  The default is 20.
Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
BASE64(1)                         User Commands                        BASE64(1)
base64 - base64 encode/decode data and print to standard output
base64 [OPTION]... [FILE]
Base64 encode or decode FILE, or standard input, to standard output.
The data are encoded as described for the base64 alphabet in RFC 4648. When decoding, the input may contain newlines in addition to the bytes of the formal base64 alphabet.  Use --ignore-garbage to attempt to recover from any other non-alphabet bytes in the encoded stream.
Full documentation <https://www.gnu.org/software/coreutils/base64> or available locally via: info '(coreutils) base64 invocation'
GEM(1)                            User Commands                           GEM(1)
gem - the front end to RubyGems
gem command [arguments...] [options...]
gem -h | --help
gem -v | --version
gem is the front end to RubyGems, a sophisticated package manager for Ruby. This is a basic help message containing pointers to more information.
Further help:
gem help commands list all 'gem' commands
gem help examples show some examples of usage
gem help <COMMAND> show help on COMMAND
(e.g. 'gem help install')
Further information:
http://rubygems.rubyforge.org
gem install rake gem list --local gem build package.gemspec gem help install
IW(8)                                 Linux                                IW(8)
iw - show / manipulate wireless devices and their configuration
iw [ OPTIONS ] { help [ command ] | OBJECT COMMAND }
OBJECT := { dev | phy | reg }
OPTIONS := { --version | --debug }
--version print version information and exit.
--debug enable netlink message debugging.
IW - COMMAND SYNTAX OBJECT dev <interface name> - network interface.
phy <phy name> - wireless hardware device (by name).
phy#<phy index> - wireless hardware device (by index).
reg    - regulatory agent.
COMMAND Specifies the action to perform on the object.  The set of possible actions depends on the object type.  iw help will print all supported commands, while iw help command will print the help for all matching commands.
ip(8), crda(8), regdbdump(8), regulatory.bin(5).
Documentation at kernel wiki ⟨https://wireless.wiki.kernel.org/en/users/Documentation/iw⟩.
pulseaudio(1)                General Commands Manual               pulseaudio(1)
pulseaudio - The PulseAudio Sound System
pulseaudio [options]
pulseaudio --help
pulseaudio --version
pulseaudio --dump-conf
pulseaudio --dump-modules
pulseaudio --dump-resample-methods
pulseaudio --cleanup-shm
pulseaudio --start
pulseaudio --kill