mirror of
				https://github.com/RGBCube/serenity
				synced 2025-10-31 09:52:44 +00:00 
			
		
		
		
	Profiler: Add help documentation
This commit is contained in:
		
							parent
							
								
									8f867df31a
								
							
						
					
					
						commit
						0ffc06b795
					
				
					 3 changed files with 61 additions and 1 deletions
				
			
		
							
								
								
									
										47
									
								
								Base/usr/share/man/man1/Profiler.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										47
									
								
								Base/usr/share/man/man1/Profiler.md
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,47 @@ | |||
| ## Name | ||||
| 
 | ||||
| Profiler - Serenity process profiler | ||||
| 
 | ||||
| ## Synopsis | ||||
| 
 | ||||
| ```**sh | ||||
| $ Profiler [--pid PID] [perfcore file] | ||||
| ``` | ||||
| 
 | ||||
| ## Description | ||||
| 
 | ||||
| Profiler facilitates process performance profiling and provides a GUI offering | ||||
| visual graph and tree representations to easily navigate generated profiling | ||||
| information. | ||||
| 
 | ||||
| If no arguments are provided, a window containing a list of running processes | ||||
| is presented, allowing a process to be selected for profiling. | ||||
| 
 | ||||
| Profiling information is written to `perfcore.<pid>` in the working directory | ||||
| and opened immediately for browsing following termination of profiling. | ||||
| 
 | ||||
| Profiler can also load performance information from previously created | ||||
| `perfcore` files. | ||||
| 
 | ||||
| ## Options | ||||
| 
 | ||||
| * `-p PID`, `--pid PID`: PID to profile | ||||
| 
 | ||||
| ## Examples | ||||
| 
 | ||||
| Profile running Shell process: | ||||
| 
 | ||||
| ```sh | ||||
| $ Profiler -p $(pidof Shell) | ||||
| ``` | ||||
| 
 | ||||
| Open a previously created perfcore file for browsing: | ||||
| 
 | ||||
| ```sh | ||||
| $ Profiler perfcore.123 | ||||
| ``` | ||||
| 
 | ||||
| ## See also | ||||
| 
 | ||||
| * [`perfcore`(5)](../man5/perfcore.md) | ||||
| 
 | ||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Brendan Coles
						Brendan Coles