Add dunstctl man page
This commit is contained in:
		
							parent
							
								
									5aa1863762
								
							
						
					
					
						commit
						6ba430a818
					
				
							
								
								
									
										11
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										11
									
								
								Makefile
									
									
									
									
									
								
							| @ -106,9 +106,15 @@ test/test: ${OBJ} ${TEST_OBJ} | |||||||
| 	${CC} -o ${@} ${TEST_OBJ} $(filter-out ${TEST_OBJ:test/%=src/%},${OBJ}) ${CFLAGS} ${LDFLAGS} | 	${CC} -o ${@} ${TEST_OBJ} $(filter-out ${TEST_OBJ:test/%=src/%},${OBJ}) ${CFLAGS} ${LDFLAGS} | ||||||
| 
 | 
 | ||||||
| .PHONY: doc doc-doxygen | .PHONY: doc doc-doxygen | ||||||
| doc: docs/dunst.1 | doc: docs/dunst.1 docs/dunstctl.1 | ||||||
|  | 
 | ||||||
|  | # Can't dedup this as we need to explicitly provide the name and title text to
 | ||||||
|  | # pod2man :(
 | ||||||
| docs/dunst.1: docs/dunst.pod | docs/dunst.1: docs/dunst.pod | ||||||
| 	${POD2MAN} --name=dunst -c "Dunst Reference" --section=1 --release=${VERSION} $< > $@ | 	${POD2MAN} --name=dunst -c "Dunst Reference" --section=1 --release=${VERSION} $< > $@ | ||||||
|  | docs/dunstctl.1: docs/dunstctl.pod | ||||||
|  | 	${POD2MAN} --name=dunstctl -c "dunstctl reference" --section=1 --release=${VERSION} $< > $@ | ||||||
|  | 
 | ||||||
| doc-doxygen: | doc-doxygen: | ||||||
| 	${DOXYGEN} docs/internal/Doxyfile | 	${DOXYGEN} docs/internal/Doxyfile | ||||||
| 
 | 
 | ||||||
| @ -137,6 +143,7 @@ clean-dunstify: | |||||||
| 
 | 
 | ||||||
| clean-doc: | clean-doc: | ||||||
| 	rm -f docs/dunst.1 | 	rm -f docs/dunst.1 | ||||||
|  | 	rm -f docs/dunstctl.1 | ||||||
| 	rm -fr docs/internal/html | 	rm -fr docs/internal/html | ||||||
| 	rm -fr docs/internal/coverage | 	rm -fr docs/internal/coverage | ||||||
| 
 | 
 | ||||||
| @ -160,6 +167,7 @@ install: install-dunst install-dunstctl install-doc install-service install-duns | |||||||
| install-dunst: dunst doc | install-dunst: dunst doc | ||||||
| 	install -Dm755 dunst ${DESTDIR}${BINDIR}/dunst | 	install -Dm755 dunst ${DESTDIR}${BINDIR}/dunst | ||||||
| 	install -Dm644 docs/dunst.1 ${DESTDIR}${MANPREFIX}/man1/dunst.1 | 	install -Dm644 docs/dunst.1 ${DESTDIR}${MANPREFIX}/man1/dunst.1 | ||||||
|  | 	install -Dm644 docs/dunstctl.1 ${DESTDIR}${MANPREFIX}/man1/dunstctl.1 | ||||||
| 
 | 
 | ||||||
| install-dunstctl: dunstctl | install-dunstctl: dunstctl | ||||||
| 	install -Dm755 dunstctl ${DESTDIR}${BINDIR}/dunstctl | 	install -Dm755 dunstctl ${DESTDIR}${BINDIR}/dunstctl | ||||||
| @ -183,6 +191,7 @@ uninstall: uninstall-service uninstall-dunstctl | |||||||
| 	rm -f ${DESTDIR}${BINDIR}/dunst | 	rm -f ${DESTDIR}${BINDIR}/dunst | ||||||
| 	rm -f ${DESTDIR}${BINDIR}/dunstify | 	rm -f ${DESTDIR}${BINDIR}/dunstify | ||||||
| 	rm -f ${DESTDIR}${MANPREFIX}/man1/dunst.1 | 	rm -f ${DESTDIR}${MANPREFIX}/man1/dunst.1 | ||||||
|  | 	rm -f ${DESTDIR}${MANPREFIX}/man1/dunstctl.1 | ||||||
| 	rm -rf ${DESTDIR}${DATADIR}/dunst | 	rm -rf ${DESTDIR}${DATADIR}/dunst | ||||||
| 
 | 
 | ||||||
| uninstall-dunstctl: | uninstall-dunstctl: | ||||||
|  | |||||||
							
								
								
									
										59
									
								
								docs/dunstctl.pod
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										59
									
								
								docs/dunstctl.pod
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,59 @@ | |||||||
|  | =head1 NAME | ||||||
|  | 
 | ||||||
|  | dunstctl - Command line control utility for dunst, a customizable and lightweight notification-daemon | ||||||
|  | 
 | ||||||
|  | =head1 SYNOPSIS | ||||||
|  | 
 | ||||||
|  | dunstctl COMMAND [PARAMETER] | ||||||
|  | 
 | ||||||
|  | =head1 COMMANDS | ||||||
|  | 
 | ||||||
|  | =over 4 | ||||||
|  | 
 | ||||||
|  | =item B<action> notification_position | ||||||
|  | 
 | ||||||
|  | Performs the default action or, if not available, opens the context menu of the | ||||||
|  | notification at the given position (starting count at the top, first | ||||||
|  | notification being 0).  | ||||||
|  | 
 | ||||||
|  | =item B<close> | ||||||
|  | 
 | ||||||
|  | Close the topmost notification currently being displayed. | ||||||
|  | 
 | ||||||
|  | =item B<close-all> | ||||||
|  | 
 | ||||||
|  | Close all notifications currently being displayed | ||||||
|  | 
 | ||||||
|  | =item B<context> | ||||||
|  | 
 | ||||||
|  | Open the context menu, presenting all available actions and urls for the | ||||||
|  | currently open notifications. | ||||||
|  | 
 | ||||||
|  | =item B<history-pop> | ||||||
|  | 
 | ||||||
|  | Redisplay the notification that was most recently closed. This can be called | ||||||
|  | multiple times to show older notifications, up to the history limit configured | ||||||
|  | in dunst. | ||||||
|  | 
 | ||||||
|  | =item B<running> | ||||||
|  | 
 | ||||||
|  | Check if dunst is currently running or paused. If dunst is paused notifications | ||||||
|  | will be kept but not shown until it is unpaused. | ||||||
|  | 
 | ||||||
|  | =item B<set-running> true/false | ||||||
|  | 
 | ||||||
|  | Set the paused status of dunst. If true, dunst is running normally, if false, | ||||||
|  | dunst is paused. See the running command and the dunst man page for more | ||||||
|  | information. | ||||||
|  | 
 | ||||||
|  | =item B<debug> | ||||||
|  | 
 | ||||||
|  | Tries to contact dunst and checks for common faults between dunstctl and dunst. | ||||||
|  | Useful if something isn't working | ||||||
|  | 
 | ||||||
|  | =item B<help> | ||||||
|  | 
 | ||||||
|  | Show all available commands with a brief description | ||||||
|  | 
 | ||||||
|  | =back | ||||||
|  | 
 | ||||||
| @ -14,6 +14,7 @@ bin/dunstify | |||||||
| dbus/org.knopwob.dunst.service | dbus/org.knopwob.dunst.service | ||||||
| share/dunst/dunstrc | share/dunst/dunstrc | ||||||
| share/man/man1/dunst.1 | share/man/man1/dunst.1 | ||||||
|  | share/man/man1/dunstctl.1 | ||||||
| systemd/dunst.service | systemd/dunst.service | ||||||
| EOF | EOF | ||||||
| 
 | 
 | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user
	 Nikos Tsipinakis
						Nikos Tsipinakis