Renamed commands

This commit is contained in:
Dakshinamurthy Karra 2021-07-05 15:56:59 +05:30
parent 84ec2de68c
commit c1c77c0f9b
14 changed files with 552 additions and 553 deletions

8
.gitignore vendored
View file

@ -23,9 +23,9 @@ src/osd-demo
src/osd-demo.o
src/osd-example
src/osd-example.o
src/osd-show-file
src/osd-show-file.o
src/osd-show-key
src/osd-show-key.o
src/osd-cat
src/osd-cat.o
src/osd-echo
src/osd-echo.o
src/utf8.o
xosd-xft.pc

View file

@ -7,8 +7,8 @@ Inspired by [libxosd](https://sourceforge.net/projects/libxosd/).
* Use Xft/TTF fonts
* Xrandr and Xinerama extensions
* Allows you to choose a monitor in multihead setups - including active monitor
* Use `osd-show-key` to display a [Nerd Font](https://nerdfonts.com) glyph
* Use `osd-show-file` to display a file
* Use `osd-echo` to display a [Nerd Font](https://nerdfonts.com) glyph
* Use `osd-cat` to display a file
# Installation
@ -20,31 +20,31 @@ sudo make install
# Quick Look
## Using osd-show-key
## Using osd-echo
To display volume off glyph and execute `amixer` command:
```bash
osd-show-key -e 'amixer set Master off' :fa-volume_off:")
osd-echo -e 'amixer set Master off' :fa-volume_off:")
```
To list available glyph names that contain `volume` in them:
```
osd-show-key -lvolume
osd-echo -lvolume
```
## Using osd-showfile
To override the font used to display a file:
```bash
osd-show-file -f "SourceCodePro:size=14" /etc/passwd
osd-cat -f "SourceCodePro:size=14" /etc/passwd
```
The following command shows the output of uptime on the screen and updates every 5 seconds:
```bash
while true; do uptime; sleep 5; done | osd-show-file --number-of-lines 1 -g 0x1l+0-0
while true; do uptime; sleep 5; done | osd-cat --number-of-lines 1 -g 0x1l+0-0
```
## Using the library

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ SUFFIXES = .md
touch $@ ; \
fi
man_MANS = osd-show-key.1 osd-show-file.1 osd-demo.1 \
man_MANS = osd-echo.1 osd-cat.1 osd-demo.1 \
xosd-xft.3 osd_create.3 osd_destroy.3 osd_display.3 osd_hide.3 \
osd_parse_geometry.3 osd_set_bgcolor.3 osd_set_color.3 osd_set_debug_level.3 \
osd_set_font.3 osd_set_geometry.3 osd_set_monitor.3 osd_set_number_of_lines.3 \

View file

@ -289,7 +289,7 @@ top_build_prefix = @top_build_prefix@
top_builddir = @top_builddir@
top_srcdir = @top_srcdir@
SUFFIXES = .md
man_MANS = osd-show-key.1 osd-show-file.1 osd-demo.1 \
man_MANS = osd-echo.1 osd-cat.1 osd-demo.1 \
xosd-xft.3 osd_create.3 osd_destroy.3 osd_display.3 osd_hide.3 \
osd_parse_geometry.3 osd_set_bgcolor.3 osd_set_color.3 osd_set_debug_level.3 \
osd_set_font.3 osd_set_geometry.3 osd_set_monitor.3 osd_set_number_of_lines.3 \

1
man/osd-cat.1 Normal file
View file

@ -0,0 +1 @@
.so osd-echo.1

View file

@ -1 +1 @@
.so osd-show-key.1
.so osd-echo.1

View file

@ -4,29 +4,29 @@
.hy
.SH NAME
.PP
osd-show-key, osd-show-file, osd-demo - Show information in a OSD window
osd-echo, osd-cat, osd-demo - Show information in a OSD window
.SH SYNOPSIS
.PP
osd-show-key [\f[I]options\f[R]] \f[I]message\f[R]
osd-echo [\f[I]options\f[R]] \f[I]message\f[R]
.PP
osd-show-file [\f[I]options\f[R]] [\f[I]file\f[R]]
osd-cat [\f[I]options\f[R]] [\f[I]file\f[R]]
.PP
osd\[en]demo [\f[I]options\f[R]]
.SH DESCRIPTION
.PP
\f[C]osd-show-key\f[R] shows a message in a translucent window on the
\f[C]osd-echo\f[R] shows a message in a translucent window on the
screen.
\f[C]osd-show-key\f[R] can understand unicode escape sequences in the
\f[C]osd-echo\f[R] can understand unicode escape sequences in the
message and can also understand glyph names from Nerd fonts.
.PP
\f[C]osd-show-file\f[R] shows a given file in a OSD window.
If a file is not given \f[C]osd-show-file\f[R] reads from the standard
\f[C]osd-cat\f[R] shows a given file in a OSD window.
If a file is not given \f[C]osd-cat\f[R] reads from the standard
input.
.PP
\f[C]osd-demo\f[R] is a small program that shows the capabilities of
\f[C]xosd-xft\f[R] library.
.PP
Both \f[C]osd-show-key\f[R] and \f[C]osd-show-file\f[R] provides various
Both \f[C]osd-echo\f[R] and \f[C]osd-cat\f[R] provides various
options to control the colors, font and geometry used to display the
information.
.SH OPTIONS
@ -116,13 +116,13 @@ Monitor to display message
\f[R]
.fi
.PP
Besides the above options \f[C]osd-show-file\f[R] accepts the following
Besides the above options \f[C]osd-cat\f[R] accepts the following
options:
.TP
-n \f[I]NUMBER\f[R], --number-of-lines=\f[I]NUMBER\f[R]
Number of lines to display
.PP
The \f[C]osd-show-key\f[R] command accepts the following additional
The \f[C]osd-echo\f[R] command accepts the following additional
options:
.TP
-e \f[I]COMMAND\f[R], --exec=\f[I]COMMAND\f[R]
@ -137,7 +137,7 @@ To display \f[C]/etc/passwd\f[R]:
.IP
.nf
\f[C]
osd-show-file /etc/passwd
osd-cat /etc/passwd
\f[R]
.fi
.SH AUTHORS

View file

@ -4,29 +4,29 @@
# NAME
osd-show-key, osd-show-file, osd-demo - Show information in a OSD window
osd-echo, osd-cat, osd-demo - Show information in a OSD window
# SYNOPSIS
osd-show-key [*options*] *message*
osd-echo [*options*] *message*
osd-show-file [*options*] [*file*]
osd-cat [*options*] [*file*]
osd--demo [*options*]
# DESCRIPTION
`osd-show-key` shows a message in a translucent window on the screen.
`osd-show-key` can understand unicode escape sequences in the message and
`osd-echo` shows a message in a translucent window on the screen.
`osd-echo` can understand unicode escape sequences in the message and
can also understand glyph names from Nerd fonts.
`osd-show-file` shows a given file in a OSD window. If a file is not given
`osd-show-file` reads from the standard input.
`osd-cat` shows a given file in a OSD window. If a file is not given
`osd-cat` reads from the standard input.
`osd-demo` is a small program that shows the capabilities of `xosd-xft`
library.
Both `osd-show-key` and `osd-show-file` provides various options to control
Both `osd-echo` and `osd-cat` provides various options to control
the colors, font and geometry used to display the information.
# OPTIONS
@ -101,12 +101,12 @@ the colors, font and geometry used to display the information.
monitors.
```
Besides the above options `osd-show-file` accepts the following options:
Besides the above options `osd-cat` accepts the following options:
-n *NUMBER*, \--number-of-lines=*NUMBER*
: Number of lines to display
The `osd-show-key` command accepts the following additional options:
The `osd-echo` command accepts the following additional options:
-e *COMMAND*, \--exec=*COMMAND*
: Executes the command using system(3) before displaying the window
@ -119,25 +119,25 @@ The `osd-show-key` command accepts the following additional options:
To display `/etc/passwd`:
```
osd-show-file /etc/passwd
osd-cat /etc/passwd
```
To override the font used to display a file:
```
osd-show-file -f "SourceCodePro:size=14" /etc/passwd
osd-cat -f "SourceCodePro:size=14" /etc/passwd
```
To override the geometry - using 120 characters width and 30 lines height:
```
osd-show-file -g 120cx30l /etc/passwd
osd-cat -g 120cx30l /etc/passwd
```
To display volume off glyph and execute `amixer` command:
```
osd-show-key -e 'amixer set Master toggle' :fa-volume_off:")
osd-echo -e 'amixer set Master toggle' :fa-volume_off:")
```
To list available glyph names that contain `volume` in them:
```
osd-show-key -lvolume
osd-echo -lvolume
```

View file

@ -1 +0,0 @@
.so osd-show-key.1

View file

@ -1,17 +1,17 @@
noinst_PROGRAMS = osd-example
bin_PROGRAMS = osd-demo osd-show-file osd-show-key
bin_PROGRAMS = osd-demo osd-cat osd-echo
osd_demo_SOURCES = osd-demo.c
osd_demo_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_show_file_SOURCES = osd-show-file.c
osd_cat_SOURCES = osd-cat.c
osd_show_file_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_cat_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_show_key_SOURCES = osd-show-key.c utf8.c nerdfonts.c
osd_echo_SOURCES = osd-echo.c utf8.c nerdfonts.c
osd_show_key_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_echo_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_example_SOURCES = osd-example.c

View file

@ -90,8 +90,7 @@ POST_UNINSTALL = :
build_triplet = @build@
host_triplet = @host@
noinst_PROGRAMS = osd-example$(EXEEXT)
bin_PROGRAMS = osd-demo$(EXEEXT) osd-show-file$(EXEEXT) \
osd-show-key$(EXEEXT)
bin_PROGRAMS = osd-demo$(EXEEXT) osd-cat$(EXEEXT) osd-echo$(EXEEXT)
subdir = src
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/m4/libtool.m4 \
@ -107,23 +106,23 @@ CONFIG_CLEAN_FILES =
CONFIG_CLEAN_VPATH_FILES =
am__installdirs = "$(DESTDIR)$(bindir)" "$(DESTDIR)$(includedir)"
PROGRAMS = $(bin_PROGRAMS) $(noinst_PROGRAMS)
am_osd_demo_OBJECTS = osd-demo.$(OBJEXT)
osd_demo_OBJECTS = $(am_osd_demo_OBJECTS)
osd_demo_DEPENDENCIES = libxosd-xft/libxosd-xft.la
am_osd_cat_OBJECTS = osd-cat.$(OBJEXT)
osd_cat_OBJECTS = $(am_osd_cat_OBJECTS)
osd_cat_DEPENDENCIES = libxosd-xft/libxosd-xft.la
AM_V_lt = $(am__v_lt_@AM_V@)
am__v_lt_ = $(am__v_lt_@AM_DEFAULT_V@)
am__v_lt_0 = --silent
am__v_lt_1 =
am_osd_demo_OBJECTS = osd-demo.$(OBJEXT)
osd_demo_OBJECTS = $(am_osd_demo_OBJECTS)
osd_demo_DEPENDENCIES = libxosd-xft/libxosd-xft.la
am_osd_echo_OBJECTS = osd-echo.$(OBJEXT) utf8.$(OBJEXT) \
nerdfonts.$(OBJEXT)
osd_echo_OBJECTS = $(am_osd_echo_OBJECTS)
osd_echo_DEPENDENCIES = libxosd-xft/libxosd-xft.la
am_osd_example_OBJECTS = osd-example.$(OBJEXT)
osd_example_OBJECTS = $(am_osd_example_OBJECTS)
osd_example_DEPENDENCIES = libxosd-xft/libxosd-xft.la
am_osd_show_file_OBJECTS = osd-show-file.$(OBJEXT)
osd_show_file_OBJECTS = $(am_osd_show_file_OBJECTS)
osd_show_file_DEPENDENCIES = libxosd-xft/libxosd-xft.la
am_osd_show_key_OBJECTS = osd-show-key.$(OBJEXT) utf8.$(OBJEXT) \
nerdfonts.$(OBJEXT)
osd_show_key_OBJECTS = $(am_osd_show_key_OBJECTS)
osd_show_key_DEPENDENCIES = libxosd-xft/libxosd-xft.la
AM_V_P = $(am__v_P_@AM_V@)
am__v_P_ = $(am__v_P_@AM_DEFAULT_V@)
am__v_P_0 = false
@ -139,9 +138,9 @@ am__v_at_1 =
DEFAULT_INCLUDES = -I.@am__isrc@
depcomp = $(SHELL) $(top_srcdir)/depcomp
am__maybe_remake_depfiles = depfiles
am__depfiles_remade = ./$(DEPDIR)/nerdfonts.Po ./$(DEPDIR)/osd-demo.Po \
./$(DEPDIR)/osd-example.Po ./$(DEPDIR)/osd-show-file.Po \
./$(DEPDIR)/osd-show-key.Po ./$(DEPDIR)/utf8.Po
am__depfiles_remade = ./$(DEPDIR)/nerdfonts.Po ./$(DEPDIR)/osd-cat.Po \
./$(DEPDIR)/osd-demo.Po ./$(DEPDIR)/osd-echo.Po \
./$(DEPDIR)/osd-example.Po ./$(DEPDIR)/utf8.Po
am__mv = mv -f
COMPILE = $(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) \
$(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
@ -161,10 +160,10 @@ AM_V_CCLD = $(am__v_CCLD_@AM_V@)
am__v_CCLD_ = $(am__v_CCLD_@AM_DEFAULT_V@)
am__v_CCLD_0 = @echo " CCLD " $@;
am__v_CCLD_1 =
SOURCES = $(osd_demo_SOURCES) $(osd_example_SOURCES) \
$(osd_show_file_SOURCES) $(osd_show_key_SOURCES)
DIST_SOURCES = $(osd_demo_SOURCES) $(osd_example_SOURCES) \
$(osd_show_file_SOURCES) $(osd_show_key_SOURCES)
SOURCES = $(osd_cat_SOURCES) $(osd_demo_SOURCES) $(osd_echo_SOURCES) \
$(osd_example_SOURCES)
DIST_SOURCES = $(osd_cat_SOURCES) $(osd_demo_SOURCES) \
$(osd_echo_SOURCES) $(osd_example_SOURCES)
RECURSIVE_TARGETS = all-recursive check-recursive cscopelist-recursive \
ctags-recursive dvi-recursive html-recursive info-recursive \
install-data-recursive install-dvi-recursive \
@ -398,10 +397,10 @@ top_builddir = @top_builddir@
top_srcdir = @top_srcdir@
osd_demo_SOURCES = osd-demo.c
osd_demo_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_show_file_SOURCES = osd-show-file.c
osd_show_file_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_show_key_SOURCES = osd-show-key.c utf8.c nerdfonts.c
osd_show_key_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_cat_SOURCES = osd-cat.c
osd_cat_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_echo_SOURCES = osd-echo.c utf8.c nerdfonts.c
osd_echo_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
osd_example_SOURCES = osd-example.c
osd_example_LDADD = libxosd-xft/libxosd-xft.la @XFT_LIBS@ @X11_LIBS@ @XRENDER_LIBS@
include_HEADERS = xosd-xft.h
@ -499,22 +498,22 @@ clean-noinstPROGRAMS:
echo " rm -f" $$list; \
rm -f $$list
osd-cat$(EXEEXT): $(osd_cat_OBJECTS) $(osd_cat_DEPENDENCIES) $(EXTRA_osd_cat_DEPENDENCIES)
@rm -f osd-cat$(EXEEXT)
$(AM_V_CCLD)$(LINK) $(osd_cat_OBJECTS) $(osd_cat_LDADD) $(LIBS)
osd-demo$(EXEEXT): $(osd_demo_OBJECTS) $(osd_demo_DEPENDENCIES) $(EXTRA_osd_demo_DEPENDENCIES)
@rm -f osd-demo$(EXEEXT)
$(AM_V_CCLD)$(LINK) $(osd_demo_OBJECTS) $(osd_demo_LDADD) $(LIBS)
osd-echo$(EXEEXT): $(osd_echo_OBJECTS) $(osd_echo_DEPENDENCIES) $(EXTRA_osd_echo_DEPENDENCIES)
@rm -f osd-echo$(EXEEXT)
$(AM_V_CCLD)$(LINK) $(osd_echo_OBJECTS) $(osd_echo_LDADD) $(LIBS)
osd-example$(EXEEXT): $(osd_example_OBJECTS) $(osd_example_DEPENDENCIES) $(EXTRA_osd_example_DEPENDENCIES)
@rm -f osd-example$(EXEEXT)
$(AM_V_CCLD)$(LINK) $(osd_example_OBJECTS) $(osd_example_LDADD) $(LIBS)
osd-show-file$(EXEEXT): $(osd_show_file_OBJECTS) $(osd_show_file_DEPENDENCIES) $(EXTRA_osd_show_file_DEPENDENCIES)
@rm -f osd-show-file$(EXEEXT)
$(AM_V_CCLD)$(LINK) $(osd_show_file_OBJECTS) $(osd_show_file_LDADD) $(LIBS)
osd-show-key$(EXEEXT): $(osd_show_key_OBJECTS) $(osd_show_key_DEPENDENCIES) $(EXTRA_osd_show_key_DEPENDENCIES)
@rm -f osd-show-key$(EXEEXT)
$(AM_V_CCLD)$(LINK) $(osd_show_key_OBJECTS) $(osd_show_key_LDADD) $(LIBS)
mostlyclean-compile:
-rm -f *.$(OBJEXT)
@ -522,10 +521,10 @@ distclean-compile:
-rm -f *.tab.c
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/nerdfonts.Po@am__quote@ # am--include-marker
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/osd-cat.Po@am__quote@ # am--include-marker
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/osd-demo.Po@am__quote@ # am--include-marker
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/osd-echo.Po@am__quote@ # am--include-marker
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/osd-example.Po@am__quote@ # am--include-marker
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/osd-show-file.Po@am__quote@ # am--include-marker
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/osd-show-key.Po@am__quote@ # am--include-marker
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/utf8.Po@am__quote@ # am--include-marker
$(am__depfiles_remade):
@ -784,10 +783,10 @@ clean-am: clean-binPROGRAMS clean-generic clean-libtool \
distclean: distclean-recursive
-rm -f ./$(DEPDIR)/nerdfonts.Po
-rm -f ./$(DEPDIR)/osd-cat.Po
-rm -f ./$(DEPDIR)/osd-demo.Po
-rm -f ./$(DEPDIR)/osd-echo.Po
-rm -f ./$(DEPDIR)/osd-example.Po
-rm -f ./$(DEPDIR)/osd-show-file.Po
-rm -f ./$(DEPDIR)/osd-show-key.Po
-rm -f ./$(DEPDIR)/utf8.Po
-rm -f Makefile
distclean-am: clean-am distclean-compile distclean-generic \
@ -835,10 +834,10 @@ installcheck-am:
maintainer-clean: maintainer-clean-recursive
-rm -f ./$(DEPDIR)/nerdfonts.Po
-rm -f ./$(DEPDIR)/osd-cat.Po
-rm -f ./$(DEPDIR)/osd-demo.Po
-rm -f ./$(DEPDIR)/osd-echo.Po
-rm -f ./$(DEPDIR)/osd-example.Po
-rm -f ./$(DEPDIR)/osd-show-file.Po
-rm -f ./$(DEPDIR)/osd-show-key.Po
-rm -f ./$(DEPDIR)/utf8.Po
-rm -f Makefile
maintainer-clean-am: distclean-am maintainer-clean-generic